Skip to main content

Pause Deployment

Pauses a specified Deployment, stopping scheduled triggers. The response returns the Deployment object with status set to paused.

Prerequisites

Endpoint and authentication configured. For details, see Overview and authentication.

Endpoint

POST /deployments/{deployment_id}/pause

Path parameters

FieldRequiredTypeDescription
deployment_idYesstringDeployment ID

Request example

curl -X POST "$AGENTSTUDIO_URL/deployments/depl_xxx/pause" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Response example

{
  "id": "depl_xxx",
  "type": "deployment",
  "name": "daily-order-summary",
  "status": "paused",
  "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": null
  },
  "initial_events": [
    {
      "type": "message",
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "Summarize yesterday's order data"
        }
      ]
    }
  ],
  "resources": [],
  "vault_ids": [],
  "metadata": {},
  "paused_reason": {
    "type": "manual"
  },
  "archived_at": null,
  "created_at": "2026-07-28T01:00:00Z",
  "updated_at": "2026-07-28T01:00:00Z",
  "request_id": "req_xxx"
}

Response fields

FieldTypeDescription
idstringDeployment ID
typestringAlways deployment
namestringDeployment name
descriptionstringDeployment purpose description
agentobjectSnapshot of the associated Agent at the locked version
environment_idstringAssociated Environment ID
scheduleobjectSchedule trigger configuration. next_run_at is null when paused
initial_eventsarray<object>Initial events sent to the Agent on trigger
resourcesarray<object>Mounted file resources
vault_idsarray<string>Associated Vault ID list
metadataobjectCustom key-value pairs
statusstringAlways paused after this operation
paused_reasonobjectPause reason
archived_atstring | nullArchive timestamp; null if not archived
created_atstringCreation time, ISO 8601
updated_atstringLast update time, ISO 8601
request_idstringUnique request identifier

Error codes

HTTP statusError codeDescription
400InvalidParameterRequired parameter missing or invalid
401InvalidApiKeyInvalid API key provided
409DEPLOYMENT_STATE_CONFLICTCannot pause an archived deployment
Flow Agent API
Sandbox API
RAG API
Long-term Memory
ParseX API
Security API
Framework Integration