Manually triggers a single Deployment execution. The response returns a Deployment Run object that tracks the execution lifecycle.
Prerequisites
Endpoint and authentication configured. For details, see Overview and authentication.
Endpoint
POST /deployments/{deployment_id}/run
Path parameters
| Field | Required | Type | Description |
|---|---|---|---|
deployment_id | Yes | string | Deployment ID |
Request example
Response example
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Deployment Run ID |
type | string | Always deployment_run |
deployment_id | string | Associated Deployment ID |
agent | object | Associated Agent; contains id and version |
session_id | string | null | Session ID; null until the async session creation completes |
trigger_source | string | Trigger source: manual or schedule |
status | string | Run status: running, succeeded, or failed |
error | object | null | Error info; returned only when the run fails |
started_at | string | Run start time, ISO 8601 |
finished_at | string | null | Run end time, ISO 8601; null while running |
request_id | string | Unique request identifier |
Error codes
| HTTP status | Error code | Description |
|---|---|---|
| 400 | InvalidParameter | Required parameter missing or invalid |
| 401 | InvalidApiKey | Invalid API key provided |
| 409 | DEPLOYMENT_TRIGGER_CONFLICT | Concurrent trigger conflict |