--- title: "Archive Deployment" method: POST path: "/v1/deployments/{deployment_id}/archive?beta=true" --- # Archive Deployment `POST /v1/deployments/{deployment_id}/archive?beta=true` ## Request - Base URL: `https://api.anthropic.com` - URL: `https://api.anthropic.com/v1/deployments/{deployment_id}/archive?beta=true` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `deployment_id` string, required ## Headers - `anthropic-version` string: The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). - `anthropic-beta` AnthropicBeta[]: This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - union: Beta names you can send in the `anthropic-beta` header. See [Beta headers](https://platform.claude.com/docs/en/api/beta-headers) for how to send them and where to find the name a feature needs. - string - 'message-batches-2024-09-24' | 'prompt-caching-2024-07-31' | 'computer-use-2024-10-22' | 'computer-use-2025-01-24' | 'pdfs-2024-09-25' | 'token-counting-2024-11-01' | 'token-efficient-tools-2025-02-19' | 'output-128k-2025-02-19' | 'files-api-2025-04-14' | 'mcp-client-2025-04-04' | 'mcp-client-2025-11-20' | 'dev-full-thinking-2025-05-14' | 'interleaved-thinking-2025-05-14' | 'code-execution-2025-05-22' | 'extended-cache-ttl-2025-04-11' | 'context-1m-2025-08-07' | 'context-management-2025-06-27' | 'model-context-window-exceeded-2025-08-26' | 'skills-2025-10-02' | 'fast-mode-2026-02-01' | 'output-300k-2026-03-24' | 'user-profiles-2026-03-24' | 'user-profiles-2026-08-18' | 'user-profiles-2026-09-04' | 'advisor-tool-2026-03-01' | 'managed-agents-2026-04-01' | 'cache-diagnosis-2026-04-07' | 'dreaming-2026-04-21' | 'thinking-token-count-2026-05-13' | 'server-side-fallback-2026-06-01' | 'server-side-fallback-2026-07-01' | 'fallback-credit-2026-06-01' | 'fallback-credit-2026-07-01' | 'agent-memory-2026-07-22' | 'mid-conversation-tool-changes-2026-07-01' | 'compact-2026-01-12' | 'computer-use-2025-11-24' | 'mcp-tunnels-2026-06-22' | 'structured-outputs-2025-11-13' | 'task-budgets-2026-03-13' | 'thinking-display-updates-2026-08-18' | 'ce-user-management-2026-07-13' | 'mid-conversation-output-config-2026-07-01' | 'thinking-binding-controls-2026-08-01' | 'mid-conversation-system-clear-at-2026-08-21' | 'compact-2026-09-04' | 'inline-tools-2026-09-15' | 'mcp-client-2026-09-15' | 'ce-plugins-2026-09-01' | 'spend-limit-reads-2026-09-26' | 'telemetry-destinations-2026-08-11' | 'webhooks-2026-10-07' | 'admin-user-sign-out-2026-10-08' | 'message-threads-2026-08-12' | 'analytics-usage-cost-2026-08-24' | 'experimental-claude-tag-2026-10-21' - `anthropic-workspace-id` string ## Response `200` Successful response (OK) - BetaManagedAgentsDeployment: A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule. - `type` 'deployment', required - `id` string, required: Unique identifier for this deployment. - `name` string, required: Human-readable name. - `description` string, nullable, required: Description of what the deployment does. - `agent` BetaManagedAgentsAgentReference, required: A resolved agent reference with a concrete version. - `type` 'agent', required - `id` string, required - `version` integer, required - `environment_id` string, required: ID of the `environment` where sessions run. - `vault_ids` string[], required: Vault IDs supplying stored credentials for sessions created from this deployment. - `initial_events` BetaManagedAgentsDeploymentInitialEvent[], required: Events sent to each session immediately after creation. - union: An event sent to a session immediately after it is created. Supports `user.message`, `user.define_outcome`, and `system.message`. - object: A user message sent to the session. - `type` 'user.message', required - `content` BetaManagedAgentsUserContentBlock[], required: Array of content blocks for the user message. - union: Content block in a user message. Can be `text`, `image`, or `document`. - object: Regular text content. - … - object: Image content specified directly as base64 data or as a reference via a URL. - … - object: Document content, either specified directly as base64 data, as text, or as a reference via a URL. - … - object: Placeholder for content withheld by Anthropic model policy. - … - object: An outcome the agent should work toward. The agent begins work on receipt. - `type` 'user.define_outcome', required - `description` string, required: What the agent should produce. This is the task specification. - `rubric` union, required: Rubric for grading the quality of an outcome. - BetaManagedAgentsFileRubric: Rubric referenced by a file uploaded via the Files API. - `type` 'file', required - `file_id` string, required: ID of the rubric file. - BetaManagedAgentsTextRubric: Rubric content provided inline as text. - `type` 'text', required - `content` string, required: Rubric content. Plain text or markdown — the grader treats it as freeform text. - `max_iterations` integer, nullable: Eval→revision cycles before giving up. Default 3, max 20. - object: Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt. - `type` 'system.message', required - `content` BetaManagedAgentsSystemContentBlock[], required: System content blocks to append. Text-only. - `type` 'text', required - `text` string, required: The text content. - `resources` BetaManagedAgentsSessionResourceConfig[], required: Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - union: A configured session resource. Echoes the input minus write-only credentials. - object: A GitHub repository mounted into each session's container. The authorization token is write-only and never returned. - `type` 'github_repository', required - `url` string, required: Github URL of the repository - `mount_path` string, nullable: Mount path in the container. Defaults to `/workspace/`. - `checkout` union - object - `type` 'branch', required - `name` string, required: Branch name to check out. - object - `type` 'commit', required - `sha` string, required: Full commit SHA to check out. - object: A file mounted into each session's container. - `type` 'file', required - `file_id` string, required: ID of a previously uploaded file. - `mount_path` string, nullable: Mount path in the container. Defaults to `/mnt/session/uploads/`. - object: A memory store attached to each session created from this deployment. - `type` 'memory_store', required - `memory_store_id` string, required: The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access` 'read_write' | 'read_only': Access mode for an attached memory store. - `instructions` string, nullable: Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `metadata` object, required: Arbitrary key-value metadata. Maximum 16 pairs. - `schedule` BetaManagedAgentsSchedule, required: 5-field POSIX cron schedule with computed runtime timestamps. - `type` 'cron', required - `expression` string, required: 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). - `timezone` string, required: IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). - `last_run_at` string, date-time: A timestamp in RFC 3339 format - `upcoming_runs_at` BetaTimestamp[]: 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` 'active' | 'paused', required: Lifecycle status of a deployment. - `paused_reason` union, required: Why a deployment is paused. Non-null exactly when `status` is `paused`. - object: The caller invoked the pause endpoint on the deployment. - `type` 'manual', required - object: A scheduled fire recorded a failed run whose error auto-pauses the deployment. - `type` 'error', required - `error` union, required: The error that triggered an auto-pause. Matches the failed run's `error.type`. - object: The deployment's environment was archived. - `type` 'environment_archived_error', required - object: The deployment's agent was archived. - `type` 'agent_archived_error', required - object: The deployment's environment no longer exists. - `type` 'environment_not_found_error', required - object: A vault referenced by the deployment no longer exists. - `type` 'vault_not_found_error', required - object: A file resource referenced by the deployment no longer exists. - `type` 'file_not_found_error', required - object: A referenced resource no longer exists and its kind was not reported. - `type` 'session_resource_not_found_error', required - object: The deployment's workspace was archived. - `type` 'workspace_archived_error', required - object: The deployment's organization is disabled. - `type` 'organization_disabled_error', required - object: A memory store referenced by the deployment is archived. - `type` 'memory_store_archived_error', required - object: A skill referenced by the deployment's agent no longer exists. - `type` 'skill_not_found_error', required - object: A vault referenced by the deployment is archived. - `type` 'vault_archived_error', required - object: An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `type` 'unknown_error', required - object: The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type` 'self_hosted_resources_unsupported_error', required - object: An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type` 'mcp_egress_blocked_error', required - `budget` object, nullable: A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`. - `type` 'limit', required - `max_list_cost` BetaMonetaryAmount, required: A monetary amount in a specific currency. - `currency` 'USD', required - `amount` string, required: Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `created_at` string, date-time, required: A timestamp in RFC 3339 format - `updated_at` string, date-time, required: A timestamp in RFC 3339 format - `archived_at` string, date-time, required: A timestamp in RFC 3339 format ## Other responses - `400`: Invalid argument - The client specified an invalid argument - `401`: Unauthenticated - The request does not have valid authentication credentials - `403`: Permission denied - The caller does not have permission to execute the specified operation - `404`: Not found - Some requested entity was not found - `408`: Deadline exceeded - The deadline expired before the operation could complete - `409`: Aborted - The operation was aborted due to concurrency issue - `412`: Failed precondition - Operation was rejected because the system is not in required state - `413`: Out of range - Operation was attempted past the valid range - `429`: Resource exhausted - Some resource has been exhausted (rate limiting) - `431`: Request header fields too large - Request metadata was too large - `499`: Cancelled - The operation was cancelled by the client - `500`: Internal - Internal server error - `501`: Unimplemented - The operation is not implemented or supported - `503`: Unavailable - The service is currently unavailable - `504`: Deadline exceeded - Upstream service did not respond in time ## Changes - **2026-11-05** `037a593978dc`: 1 info - added the enum value `admin-user-sign-out-2026-10-08` to the property `items/anyOf[subschema #2]/` of the `header` request parameter `anthropic-beta` - **2026-11-02** `9578ce4001dd`: 2 info - the `budget/anyOf[#/components/schemas/BetaManagedAgentsBudget]/oneOf[#/components/schemas/BetaManagedAgentsBudgetLimit]/max_list_cost/allOf[#/components/schemas/BetaMonetaryAmount]/amount` response's property pattern `^(0|[1-9]\d*)$` was added for the status `200` - the `resources/items/oneOf[#/components/schemas/BetaManagedAgentsGitHubRepositoryResourceConfig]/checkout/anyOf[#/components/schemas/BetaManagedAgentsRepositoryCheckout]/oneOf[#/components/schemas/BetaManagedAgentsCommitCheckout]/sha` response's property pattern `^[0-9a-fA-F]+$` was added for the status `200` - **2026-10-23** `f538a797852c`: 1 info - added the enum value `experimental-claude-tag-2026-10-21` to the property `items/anyOf[subschema #2]/` of the `header` request parameter `anthropic-beta` - **2026-10-23** `8071e43a8476`: 1 info - added the enum value `analytics-usage-cost-2026-08-24` to the property `items/anyOf[subschema #2]/` of the `header` request parameter `anthropic-beta` - **2026-10-22** `376dea998624`: 1 info - added the enum value `message-threads-2026-08-12` to the property `items/anyOf[subschema #2]/` of the `header` request parameter `anthropic-beta` [Operation history](https://skmtc.dev/anthropics/apis/anthropic-api/changes/v1/deployments/:deployment_id/archive%3Fbeta=true/post.md) --- [API](https://skmtc.dev/anthropics/apis/anthropic-api.md) - [All operations](https://skmtc.dev/anthropics/apis/anthropic-api/llms.txt) - [OpenAPI document](https://skmtc.dev/anthropics/apis/anthropic-api/revisions/d5be78f1f9a8?raw)