Archive a deployment

Archive a deployment. Stops all scheduled runs and hides from default listings.

POST /api/v1/cloud/deployments/{id}/archive

Archives a deployment. Archived deployments stop all scheduled runs and are hidden from default listings (pass include_archived=true to the List endpoint to see them). The archived_at timestamp is set and upcoming_runs_at becomes empty. The deployment name is appended with _archived_<unix_timestamp> to free the original name for reuse.

Archiving is irreversible via the API. There is currently no unarchive endpoint.

Path parameters

Parameter	Type	Description
id	string	Deployment ID with the dep_ prefix

Headers

Header	Required	Description
Authorization	Yes	Bearer $QODER_PAT
Content-Type	Yes	application/json

Request body

No request body is required.

Example request

curl -X POST "https://api.qoder.com/api/v1/cloud/deployments/dep_019ec55a2b687b3f94eee77dd77e4b2a/archive" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json"

Example response

HTTP 200 OK

Returns the full Deployment object with archived_at set.

{
  "agent": {
    "id": "agent_019ebb21ef8e7df6a559052c94875160",
    "type": "agent",
    "version": 1
  },
  "archived_at": "2026-06-14T08:58:42Z",
  "created_at": "2026-06-14T08:58:01Z",
  "description": "Deployment created for API documentation verification",
  "environment_id": "env_019e49a1780171daac1e6b01f290ac2b",
  "environment_variables": "",
  "id": "dep_019ec55a2b687b3f94eee77dd77e4b2a",
  "initial_events": [
    {
      "content": [
        {
          "type": "text",
          "text": "Generate today's status report"
        }
      ],
      "type": "user.message"
    }
  ],
  "metadata": {},
  "name": "api-doc-verification-deployment-v2_archived_1781427523",
  "paused_reason": null,
  "resources": [],
  "schedule": {
    "expression": "30 9 * * 1-5",
    "last_run_at": "2026-06-14T08:58:17Z",
    "timezone": "Asia/Shanghai",
    "type": "cron",
    "upcoming_runs_at": []
  },
  "status": "active",
  "type": "deployment",
  "updated_at": "2026-06-14T08:58:42Z",
  "vault_ids": []
}

Errors

HTTP	Type	Trigger
401	authentication_error	PAT invalid or expired
404	not_found_error	Deployment does not exist
409	conflict_error	Deployment is already archived

See Errors for the full error envelope.

Related

Pause a deployment

Pause scheduling while preserving configuration (reversible).

List deployments

Page through all deployments under the account.

Create a deployment

Create a new cron-scheduled or manually-triggered deployment.

Errors reference

All API error codes and the error envelope convention.