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
| Field | Required | Type | Description |
|---|---|---|---|
deployment_id | Yes | string | Deployment ID |
Request example
Response example
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Deployment ID |
type | string | Always deployment |
name | string | Deployment name |
description | string | Deployment purpose description |
agent | object | Snapshot of the associated Agent at the locked version |
environment_id | string | Associated Environment ID |
schedule | object | Schedule trigger configuration. next_run_at is null when paused |
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 | Always paused after this operation |
paused_reason | object | Pause reason |
archived_at | string | null | Archive timestamp; null if not archived |
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 |
| 409 | DEPLOYMENT_STATE_CONFLICT | Cannot pause an archived deployment |