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

FieldRequiredTypeDescription
deployment_idYesstringDeployment ID

Request body

FieldRequiredTypeDescription
nameNostringDeployment name, up to 256 characters
descriptionNostringDescription of the deployment purpose
agentNoobjectAssociated Agent
environment_idNostring | nullAssociated Environment ID
scheduleNoobject | nullSchedule trigger configuration; pass null to clear the schedule
initial_eventsNoarray<object>List of initial events sent to the Agent on trigger, 1-50 items
resourcesNoarray<object>List of mounted file resources
vault_idsNoarray<string>List of associated Vault IDs
metadataNoobjectCustom 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

FieldTypeDescription
idstring—
typestring—
namestring—
descriptionstring—
agentobject—
environment_idstring—
scheduleobject | null—
initial_eventsarray<object>—
resourcesarray<object>—
vault_idsarray<string>—
metadataobject—
statusstring—
paused_reasonobject | nullPause reason; returned only when the deployment is paused
archived_atstring | null—
created_atstring—
updated_atstring—
request_idstringUnique identifier of this request; include it when troubleshooting

Error codes

HTTP statusError codeDescription
400InvalidParameterRequired parameter missing or invalid.
401InvalidApiKeyInvalid API-key provided.
409DEPLOYMENT_STATE_CONFLICTCannot update an archived deployment.