Skip to main content
POST
TriggerDeployment

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
runBisection
boolean | null

Per-run override for the deployment's stored run_bisection setting. Unset (the default) inherits the deployment's value, so an on-demand run behaves like a scheduled one. Set false for a cheap quick-check-only run with no bisection drill-down.

executionTimeout
string<duration> | null

Per-run override for the deployment's stored execution_timeout. Unset (the default) inherits the deployment's value. Set it to bound this one run to a shorter or longer wall-clock budget; the server clamps the effective value to a supported range.

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"