Update Deployment
Updated at:
Updates the configuration of a specified Deployment. All fields are optional; only the provided fields are updated.
Prerequisites
Endpoint and authentication have been configured. For details, see API overview and authentication.
Endpoint
POST /deployments/{deployment_id}
Path parameters
| Field | Required | Type | Description |
|---|---|---|---|
deployment_id | Yes | string | Deployment ID |
Request body
| Field | Required | Type | Description |
|---|---|---|---|
name | No | string | Deployment name, up to 256 characters |
description | No | string | Description of the deployment purpose |
agent | No | object | Associated Agent |
environment_id | No | string | null | Associated Environment ID |
schedule | No | object | null | Schedule trigger configuration; pass null to clear the schedule |
initial_events | No | array<object> | List of initial events sent to the Agent on trigger, 1-50 items |
resources | No | array<object> | List of mounted file resources |
vault_ids | No | array<string> | List of associated Vault IDs |
metadata | No | object | Custom business key-value pairs |
Request example
curl -X POST "$AGENTSTUDIO_URL/deployments/depl_xxx" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Daily order summary v2",
"schedule": null
}'
Response
{
"id": "depl_xxx",
"type": "deployment",
"name": "Daily order summary v2",
"status": "active",
"agent": {
"id": "agent_xxx",
"version": 12
},
"environment_id": "env_xxx",
"schedule": null,
"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 | — |
type | string | — |
name | string | — |
description | string | — |
agent | object | — |
environment_id | string | — |
schedule | object | null | — |
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 deployment 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
| HTTP status | Error code | Description |
|---|---|---|
| 400 | InvalidParameter | Required parameter missing or invalid. |
| 401 | InvalidApiKey | Invalid API-key provided. |
| 409 | DEPLOYMENT_STATE_CONFLICT | Cannot update an archived deployment. |
Is this page helpful?