List Deployments
Updated at:
Paginated list of Deployments. Supports filtering by Agent, status, and keyword.
Prerequisites
Endpoint and authentication configured. For details, see API overview and authentication.
Endpoint
GET /deployments
Query parameters
| Field | Required | Type | Description |
|---|---|---|---|
agent_id | No | string | Filter by Agent ID |
keyword | No | string | Fuzzy search by ID or name |
status | No | string | Filter by status: active or paused |
include_archived | No | boolean | Whether to include archived Deployments; default false |
limit | No | integer | Number of items per page; max 100; default 20 |
page | No | string | Pagination cursor |
created_at[gte] | No | string | Created-at lower bound, RFC 3339 |
created_at[lte] | No | string | Created-at upper bound, RFC 3339 |
Request example
curl "$AGENTSTUDIO_URL/deployments?agent_id=agent_xxx&keyword=data&status=active&include_archived=true&limit=20" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY"
Response
The response contains data (an array of Deployment objects) and next_page (the next-page cursor; null when there is no more data).
{
"data": [
{
"id": "depl_xxx",
"type": "deployment",
"name": "Daily order summary",
"status": "active",
"agent": {
"id": "agent_xxx",
"version": 12
},
"environment_id": "env_xxx",
"schedule": {
"type": "cron",
"expression": "0 9 * * 1-5",
"timezone": "Asia/Shanghai",
"last_run_at": null,
"next_run_at": "2026-07-28T01:00:00Z"
},
"initial_events": [],
"resources": [],
"vault_ids": [],
"metadata": {},
"paused_reason": null,
"archived_at": null,
"created_at": "2026-07-28T01:00:00Z",
"updated_at": "2026-07-28T01:00:00Z",
"request_id": "req_xxx"
}
],
"next_page": null
}
Response fields
| Field | Type | Description |
|---|---|---|
data | array<object> | Array of Deployment objects |
data[].id | string | Deployment ID |
data[].type | string | Always deployment |
data[].name | string | Deployment name |
data[].description | string | Deployment purpose description |
data[].agent | object | Snapshot of the associated Agent at the locked version |
data[].environment_id | string | Associated Environment ID |
data[].schedule | object | Schedule trigger configuration |
data[].initial_events | array<object> | Initial events sent to the Agent on trigger |
data[].resources | array<object> | Mounted file resources |
data[].vault_ids | array<string> | Associated Vault ID list |
data[].metadata | object | Custom business key-value pairs |
data[].status | string | Deployment status: active or paused |
data[].paused_reason | object | null | Pause reason; returned only when the status is paused |
data[].archived_at | string | null | Archive timestamp; null if not archived |
data[].created_at | string | Creation time, ISO 8601 |
data[].updated_at | string | Last update time, ISO 8601 |
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. |
Is this page helpful?