Archive Deployment

Prerequisites

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

Endpoint

POST /deployments/{deployment_id}/archive

Path parameters

Field	Required	Type	Description
`deployment_id`	Yes	string	Deployment ID

Request example

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

Response example

{
  "id": "depl_xxx",
  "type": "deployment",
  "name": "Daily Report Generator",
  "description": "Generates daily sales reports",
  "agent": {
    "id": "agent_xxx",
    "version": 13
  },
  "environment_id": "env_xxx",
  "schedule": {
    "cron": "0 9 * * *"
  },
  "initial_events": [],
  "resources": [],
  "vault_ids": [],
  "metadata": {},
  "status": "active",
  "paused_reason": null,
  "archived_at": "2026-07-28T03:00:00Z",
  "created_at": "2026-07-20T10:00:00Z",
  "updated_at": "2026-07-28T03:00:00Z",
  "request_id": "req_xxx"
}

Response fields

Field	Type	Description
`id`	string	Deployment ID
`type`	string	Always `deployment`
`name`	string	Deployment name
`description`	string	Deployment description
`agent`	object	Associated Agent; contains `id` and `version`
`environment_id`	string	Associated Environment ID
`schedule`	object	Schedule trigger configuration
`initial_events`	array<object>	Initial events sent to the Agent on trigger
`resources`	array<object>	Mounted file resources
`vault_ids`	array<string>	Associated Vault ID list
`metadata`	object	Custom key-value pairs
`status`	string	Deployment status: `active` or `paused`
`paused_reason`	string \| null	Pause reason
`archived_at`	string	Archive timestamp, ISO 8601
`created_at`	string	Creation time, ISO 8601
`updated_at`	string	Last update time, ISO 8601
`request_id`	string	Unique request identifier

Error codes

HTTP status	Error code	Description
400	`InvalidParameter`	Required parameter missing or invalid
401	`InvalidApiKey`	Invalid API key provided

​Prerequisites

​Endpoint

​Path parameters

​Request example

​Response example

​Response fields

​Error codes

Prerequisites

Endpoint

Path parameters

Request example

Response example

Response fields

Error codes