Skip to main content
POST
/
api
/
recon
/
v1
/
deployments
/
trigger
TriggerDeployment
curl --request POST \
  --url https://developer.synq.io/api/recon/v1/deployments/trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actor": {
    "name": "<string>",
    "email": {
      "userEmail": "jsmith@example.com"
    },
    "via": "VIA_UNSPECIFIED"
  },
  "deploymentId": "<string>"
}
'
{
  "deploymentId": "<string>",
  "runId": "<string>",
  "scheduledAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.synq.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
actor
actor · object
required

Actor triggering the run. Required.

​
deploymentId
string
required

Response

200 - application/json

Success

​
deploymentId
string

Identity of the deployment that was triggered (canonical form even when the request used suite_id).

​
runId
string

Stable opaque identifier of the enqueued run. Pass this to RunStateService to track lifecycle.

​
scheduledAt
string<date-time>

When the run is scheduled to start. For TriggerDeployment this is ~now(); the worker will pick it up shortly.

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"