--- title: Archive Deployment url: https://platform.claude.com/docs/en/api/typescript/beta/deployments/archive --- # Archive Deployment `client.beta.deployments.archive(deploymentID, params?, options?): BetaManagedAgentsDeployment` **POST** `/v1/deployments/{deployment_id}/archive` Archive Deployment ## Parameters - `deploymentID: string` (path parameter) Unique identifier of the deployment to archive. - `params: DeploymentArchiveParams` - `betas?: Array` (header parameter) Optional header to specify the beta version(s) you want to use. - `(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"` - `workspace_id?: string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ## Returns - `interface 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"` - `id: string` Unique identifier for this deployment. - `agent: BetaManagedAgentsAgentReference` Reference to the agent this deployment runs, resolved to a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `archived_at: string | null` Time the deployment was archived. Null if not archived. format: date-time - `created_at: string` Time the deployment was created. format: date-time - `description: string | null` Description of what the deployment does. - `environment_id: string` ID of the `environment` where sessions run. - `initial_events: Array` Events sent to each session immediately after creation. - `interface BetaManagedAgentsDeploymentUserMessageEvent` A user message sent to the session. - `type: "user.message"` - `content: Array` Array of content blocks for the user message. - `interface BetaManagedAgentsTextBlock` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `interface BetaManagedAgentsImageBlock` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource | BetaManagedAgentsURLImageSource | BetaManagedAgentsFileImageSource` The source of the image data. - `interface BetaManagedAgentsBase64ImageSource` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `interface BetaManagedAgentsURLImageSource` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `interface BetaManagedAgentsFileImageSource` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `interface BetaManagedAgentsDocumentBlock` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource | BetaManagedAgentsPlainTextDocumentSource | BetaManagedAgentsURLDocumentSource | BetaManagedAgentsFileDocumentSource` The source of the document data. - `interface BetaManagedAgentsBase64DocumentSource` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `interface BetaManagedAgentsPlainTextDocumentSource` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `interface BetaManagedAgentsURLDocumentSource` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `interface BetaManagedAgentsFileDocumentSource` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context?: string | null` Additional context about the document for the model. - `title?: string | null` The title of the document. - `interface BetaManagedAgentsRedactedBlock` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `interface BetaManagedAgentsDeploymentUserDefineOutcomeEvent` An outcome the agent should work toward. The agent begins work on receipt. - `type: "user.define_outcome"` - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubric | BetaManagedAgentsTextRubric` How to grade the outcome. Text or file reference. - `interface BetaManagedAgentsFileRubric` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `interface BetaManagedAgentsTextRubric` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `max_iterations?: number | null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `interface BetaManagedAgentsDeploymentSystemMessageEvent` 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"` - `content: Array` System content blocks to append. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `metadata: Record` Arbitrary key-value metadata. Maximum 16 pairs. - `name: string` Human-readable name. - `paused_reason: BetaManagedAgentsDeploymentPausedReason | null` Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise. - `interface BetaManagedAgentsManualDeploymentPausedReason` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - `interface BetaManagedAgentsErrorDeploymentPausedReason` A scheduled fire recorded a failed run whose error auto-pauses the deployment. - `type: "error"` - `error: BetaManagedAgentsDeploymentPausedReasonError` The failed run's error. - `interface BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError` The deployment's environment was archived. - `type: "environment_archived_error"` - `interface BetaManagedAgentsAgentArchivedDeploymentPausedReasonError` The deployment's agent was archived. - `type: "agent_archived_error"` - `interface BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - `interface BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - `interface BetaManagedAgentsFileNotFoundDeploymentPausedReasonError` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - `interface BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - `interface BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError` The deployment's workspace was archived. - `type: "workspace_archived_error"` - `interface BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError` The deployment's organization is disabled. - `type: "organization_disabled_error"` - `interface BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - `interface BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - `interface BetaManagedAgentsVaultArchivedDeploymentPausedReasonError` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - `interface BetaManagedAgentsUnknownDeploymentPausedReasonError` An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `type: "unknown_error"` - `interface BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - `interface BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - `resources: Array` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - `interface BetaManagedAgentsGitHubRepositoryResourceConfig` A GitHub repository mounted into each session's container. The authorization token is write-only and never returned. - `type: "github_repository"` - `url: string` Github URL of the repository - `checkout?: BetaManagedAgentsBranchCheckout | BetaManagedAgentsCommitCheckout | null` Branch or commit to check out. Defaults to the repository's default branch. - `interface BetaManagedAgentsBranchCheckout` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `interface BetaManagedAgentsCommitCheckout` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `mount_path?: string | null` Mount path in the container. Defaults to `/workspace/`. - `interface BetaManagedAgentsFileResourceConfig` A file mounted into each session's container. - `type: "file"` - `file_id: string` ID of a previously uploaded file. - `mount_path?: string | null` Mount path in the container. Defaults to `/mnt/session/uploads/`. - `interface BetaManagedAgentsMemoryStoreResourceConfig` A memory store attached to each session created from this deployment. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access?: "read_write" | "read_only" | null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `instructions?: string | null` 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: BetaManagedAgentsSchedule | null` Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant. - `type: "cron"` - `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). minLength: 1, maxLength: 256 - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). minLength: 1 - `last_run_at?: string | null` Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this. format: date-time - `upcoming_runs_at?: Array` 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: BetaManagedAgentsDeploymentStatus` Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set. - `"active"` The deployment is active and can run sessions. Archived deployments also report this status; check `archived_at` to distinguish them. - `"paused"` The deployment is paused. Autonomous triggers are suppressed; manual runs are still permitted. - `updated_at: string` Time the deployment was last updated. format: date-time - `vault_ids: Array` Vault IDs supplying stored credentials for sessions created from this deployment. - `budget?: BetaManagedAgentsBudgetLimit | null` Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` 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. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. ## Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const betaManagedAgentsDeployment = await client.beta.deployments.archive( "depl_011CZkZcDH3vPqd7xnEfwTai" ); console.log(betaManagedAgentsDeployment.id); ``` ### Response (200) ```json { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } ```