TriggerDeployment
Trigger an on-demand execution of a promoted deployment. Enqueues a run
using the frozen suite snapshot and connection mappings stored on the
deployment row — execution uses platform integration credentials, not the
caller’s. Returns the freshly-allocated run_id so callers can poll
RunStateService for status.
Preconditions:
- Deployment must exist and be
active. - Deployment must have
triggerable_by_api = true(FAILED_PRECONDITION otherwise). - Deployment must not be paused (FAILED_PRECONDITION when
paused_untilis set and in the future).
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
- TriggerDeploymentRequest
- TriggerDeploymentRequest
Actor triggering the run. Required.
- actor
- actor
- actor
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.
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
Success
Identity of the deployment that was triggered (canonical form even when
the request used suite_id).
Stable opaque identifier of the enqueued run. Pass this to RunStateService to track lifecycle.
When the run is scheduled to start. For TriggerDeployment this is ~now(); the worker will pick it up shortly.
"2023-01-15T01:30:15.01Z"
"2024-12-25T12:00:00Z"