Sign in

v49

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-261319281.7 MB

Update Deployment

post/v1/deployments/{deployment_id}?beta=true

Path parameters

deployment_idstring required

Path parameter deployment_id

Headers

anthropic-versionstring
anthropic-betastring

Request body

namestring

Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.

descriptionstring nullable

Description. Omit to preserve; send empty string or null to clear.

environment_idstring

ID of the environment where sessions run. Omit to preserve. Cannot be cleared.

vault_idsstring[] nullable

Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50.

metadataobject nullable

Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars.

Example request

{
  "initial_events": [
    {
      "type": "user.message",
      "content": [
        {
          "type": "text",
          "text": "Where is my order #1234?"
        }
      ]
    }
  ],
  "resources": [
    {
      "type": "github_repository",
      "url": "https://github.com/example-org/example-repo",
      "authorization_token": "ghp_exampletoken"
    }
  ],
  "schedule": {
    "type": "cron",
    "expression": "0 9 * * 1-5",
    "timezone": "America/Los_Angeles"
  }
}

Response

Successful response (OK)

type'deployment' required
idstring required

Unique identifier for this deployment.

namestring required

Human-readable name.

descriptionstring nullable required

Description of what the deployment does.

environment_idstring required

ID of the environment where sessions run.

vault_idsstring[] required

Vault IDs supplying stored credentials for sessions created from this deployment.

metadataobject required

Arbitrary key-value metadata. Maximum 16 pairs.

status'active' | 'paused' required

Lifecycle status of a deployment.

created_atstring date-time required

A timestamp in RFC 3339 format

updated_atstring date-time required

A timestamp in RFC 3339 format

archived_atstring date-time required

A timestamp in RFC 3339 format

Example response

{
  "type": "deployment",
  "id": "depl_011CZkZcDH3vPqd7xnEfwTai",
  "name": "Daily order report",
  "description": "Compiles yesterday's orders into a report every weekday morning.",
  "agent": {
    "type": "agent",
    "id": "agent_011CZkYpogX7uDKUyvBTophP",
    "version": 1
  },
  "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
  "vault_ids": [
    "vlt_011CZkZDLs7fYzm1hXNPeRjv"
  ],
  "initial_events": [
    {
      "type": "user.message",
      "content": [
        {
          "type": "text",
          "text": "Compile yesterday's orders into report.md."
        }
      ]
    }
  ],
  "resources": [],
  "metadata": {},
  "schedule": {
    "type": "cron",
    "expression": "0 9 * * 1-5",
    "timezone": "America/Los_Angeles",
    "last_run_at": "2026-03-16T16:00:09Z",
    "upcoming_runs_at": [
      "2026-03-17T16:00:00Z",
      "2026-03-18T16:00:00Z"
    ]
  },
  "status": "active",
  "paused_reason": null,
  "created_at": "2026-03-15T10:00:00Z",
  "updated_at": "2026-03-15T10:00:00Z",
  "archived_at": null
}