Paginated list of execution records for a specified Deployment.
Prerequisites
Endpoint and authentication configured. For details, see Overview and authentication.
Endpoint
GET /deployments/{deployment_id}/runs
Path parameters
| Field | Required | Type | Description |
|---|---|---|---|
deployment_id | Yes | string | Deployment ID |
Query parameters
| Field | Required | Type | Description |
|---|---|---|---|
limit | No | integer | Page size; default 20, max 100 |
page | No | string | Pagination cursor; take from the next_page value of the previous response |
Request example
Response example
Response fields
| Field | Type | Description |
|---|---|---|
data | array<object> | Array of Deployment Run objects |
data[].id | string | Deployment Run ID |
data[].type | string | Always deployment_run |
data[].deployment_id | string | Associated Deployment ID |
data[].agent | object | Associated Agent; contains id and version |
data[].session_id | string | null | Session ID; null until the async session creation completes |
data[].trigger_source | string | Trigger source: manual or schedule |
data[].status | string | Run status: running, succeeded, or failed |
data[].error | object | null | Error info; returned only when the run fails |
data[].started_at | string | Run start time, ISO 8601 |
data[].finished_at | string | null | Run end time, ISO 8601; null while running |
data[].request_id | string | Unique request identifier |
next_page | string | null | Next page cursor; null when there is no more data |
Error codes
| HTTP status | Error code | Description |
|---|---|---|
| 400 | InvalidParameter | Required parameter missing or invalid |
| 401 | InvalidApiKey | Invalid API key provided |