Update Deployment

POST /anthropic/v1/deployments/{deployment_id}○ Unsupported

Request parameters

deployment_idstring必填
path: Deployment ID (path or query parameter).
namestring可选
Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.
agentstring | object可选
Agent to deploy. Accepts the `agent` ID string, which re-pins to the latest version, or an `agent` object with both id and version specified. Omit to preserve. Cannot be cleared.
▸ 展开子字段（3）
- idstring必填
  The `agent` ID.
- typestring必填
  取值 agent
- versionnumber可选
  The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.
environment_idstring可选
ID of the `environment` where sessions run. Omit to preserve. Cannot be cleared.
budgetobject可选
A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
▸ 展开子字段（2）
- max_list_costobject必填
  A monetary amount in a specific currency.
- typestring必填
  取值 limit
descriptionstring可选
Description. Omit to preserve; send empty string or null to clear.
initial_eventsarray可选
Initial events. Full replacement. Omit to preserve. Cannot be cleared. At least 1, maximum 50.
metadataobject可选
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.
resourcesarray可选
Session resources. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 500.
scheduleobject可选
5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
▸ 展开子字段（3）
- expressionstring必填
  5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 \* \* 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily).
- timezonestring必填
  Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.
- typestring必填
  取值 cron
▸ 更多参数（1）
- vault_idsarray可选
  Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50.

Returns

501 This endpoint is not implemented yet; calling it returns the response below:

The platform cannot run agents automatically on a schedule or by trigger yet. Calling it returns 501 (not_implemented_error), produces no side effects, and the official SDK does not retry.

Errors follow the Claude Managed Agents format — see error codes

Response

HTTP 200

Successful response

application/json

Name	Type	Description
id	string	Unique identifier for this deployment.
agent	object	A resolved agent reference with a concrete version.
agent.id	string
agent.type	string
agent.version	number
archived_at	null \| string	A timestamp in RFC 3339 format
created_at	string	A timestamp in RFC 3339 format
description	null \| string	Description of what the deployment does.
environment_id	string	ID of the `environment` where sessions run.
initial_events	array<object>	Events sent to each session immediately after creation.
initial_events[].content	array<object>	Array of content blocks for the user message. / System content blocks to append. Text-only.
initial_events[].type	string
initial_events[].description	string	What the agent should produce. This is the task specification.
initial_events[].rubric	object	Rubric for grading the quality of an outcome.
initial_events[].max_iterations	null \| number	Eval→revision cycles before giving up. Default 3, max 20.
metadata	object	Arbitrary key-value metadata. Maximum 16 pairs.
name	string	Human-readable name.
paused_reason	null \| object	Why a deployment is paused. Non-null exactly when `status` is `paused`.
paused_reason.type	string
paused_reason.error	object	The error that triggered an auto-pause. Matches the failed run's `error.type`.
resources	array<object>	Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.
resources[].type	string
resources[].url	string	Github URL of the repository
resources[].checkout	null \| object	Branch or commit to check out. Defaults to the repository's default branch.
resources[].mount_path	null \| string	Mount path in the container. Defaults to `/workspace/<repo-name>`. / Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.
resources[].file_id	string	ID of a previously uploaded file.
resources[].memory_store_id	string	The memory store ID (memstore_...). Must belong to the caller's organization and workspace.
resources[].access	null \| string	Access mode for an attached memory store.
resources[].instructions	null \| string	Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.
schedule	null \| object	5-field POSIX cron schedule with computed runtime timestamps.
schedule.expression	string	5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily).
schedule.timezone	string	IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").
schedule.type	string
schedule.last_run_at	null \| string	A timestamp in RFC 3339 format
schedule.upcoming_runs_at	array<string>	Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (`archived_at` set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time.
status	string	Lifecycle status of a deployment.
type	string
updated_at	string	A timestamp in RFC 3339 format
vault_ids	array<string>	Vault IDs supplying stored credentials for sessions created from this deployment.
budget	null \| object	A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
budget.max_list_cost	object	A monetary amount in a specific currency.
budget.type	string