Get Deployment
Updated at:
Retrieves the details of a single Deployment by ID.
Prerequisites
Endpoint and authentication configured. For details, see API overview and authentication.
Endpoint
GET /deployments/{deployment_id}
Path parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
deployment_id | Yes | string | Deployment ID |
Request example
curl "$AGENTSTUDIO_URL/deployments/depl_xxx" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY"
Response
{
"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": [
{
"type": "message",
"role": "user",
"content": [
{
"type": "text",
"text": "Summarize order data from yesterday"
}
]
}
],
"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"
}
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Deployment ID |
type | string | Fixed value deployment |
name | string | Deployment name |
description | string | Description of the deployment purpose |
agent | object | — |
environment_id | string | — |
schedule | object | — |
initial_events | array<object> | — |
resources | array<object> | — |
vault_ids | array<string> | — |
metadata | object | — |
status | string | — |
paused_reason | object | null | Pause reason; returned only when the status is paused |
archived_at | string | null | — |
created_at | string | — |
updated_at | string | — |
request_id | string | Unique identifier of this request; include it when troubleshooting |
Error codes
| Status code | Error code | Description |
|---|---|---|
| 400 | InvalidParameter | Required parameter missing or invalid. |
| 401 | InvalidApiKey | Invalid API-key provided. |
| 404 | DEPLOYMENT_NOT_FOUND | Deployment not found. |
Is this page helpful?