--- title: Archive Deployment url: https://platform.claude.com/docs/en/api/java/beta/deployments/archive --- # Archive Deployment `BetaManagedAgentsDeployment beta().deployments().archive(params = DeploymentArchiveParams.none(), requestOptions = RequestOptions.none())` **POST** `/v1/deployments/{deployment_id}/archive` Archive Deployment ## Parameters - `DeploymentArchiveParams params` - `Optional deploymentId` (path parameter) Unique identifier of the deployment to archive. - `Optional> betas` (header parameter) This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional workspaceId` (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 - `class 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 type` - `String id` Unique identifier for this deployment. - `BetaManagedAgentsAgentReference agent` Reference to the agent this deployment runs, resolved to a concrete version. - `Type type` - `String id` - `long version` format: int32 - `Optional archivedAt` Time the deployment was archived. Null if not archived. format: date-time - `LocalDateTime createdAt` Time the deployment was created. format: date-time - `Optional description` Description of what the deployment does. - `String environmentId` ID of the `environment` where sessions run. - `List initialEvents` Events sent to each session immediately after creation. - `class BetaManagedAgentsDeploymentUserMessageEvent` A user message sent to the session. - `Type type` - `List content` Array of content blocks for the user message. - `class BetaManagedAgentsTextBlock` Regular text content. - `Type type` - `String text` The text content. minLength: 1 - `class BetaManagedAgentsImageBlock` Image content specified directly as base64 data or as a reference via a URL. - `Type type` - `Source source` The source of the image data. - `class BetaManagedAgentsBase64ImageSource` Base64-encoded image data. - `Type type` - `String data` Base64-encoded image data. minLength: 1 - `String mediaType` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `class BetaManagedAgentsUrlImageSource` Image referenced by URL. - `Type type` - `String url` URL of the image to fetch. minLength: 1 - `class BetaManagedAgentsFileImageSource` Image referenced by file ID. - `Type type` - `String fileId` ID of a previously uploaded file. minLength: 1 - `class BetaManagedAgentsDocumentBlock` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `Type type` - `Source source` The source of the document data. - `class BetaManagedAgentsBase64DocumentSource` Base64-encoded document data. - `Type type` - `String data` Base64-encoded document data. minLength: 1 - `String mediaType` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `class BetaManagedAgentsPlainTextDocumentSource` Plain text document content. - `Type type` - `String data` The plain text content. minLength: 1 - `MediaType mediaType` MIME type of the text content. Must be "text/plain". - `class BetaManagedAgentsUrlDocumentSource` Document referenced by URL. - `Type type` - `String url` URL of the document to fetch. minLength: 1 - `class BetaManagedAgentsFileDocumentSource` Document referenced by file ID. - `Type type` - `String fileId` ID of a previously uploaded file. minLength: 1 - `Optional context` Additional context about the document for the model. - `Optional title` The title of the document. - `class BetaManagedAgentsRedactedBlock` Placeholder for content withheld by Anthropic model policy. - `Type type` - `class BetaManagedAgentsDeploymentUserDefineOutcomeEvent` An outcome the agent should work toward. The agent begins work on receipt. - `Type type` - `String description` What the agent should produce. This is the task specification. - `Rubric rubric` How to grade the outcome. Text or file reference. - `class BetaManagedAgentsFileRubric` Rubric referenced by a file uploaded via the Files API. - `Type type` - `String fileId` ID of the rubric file. - `class BetaManagedAgentsTextRubric` Rubric content provided inline as text. - `Type type` - `String content` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `Optional maxIterations` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `class 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 type` - `List content` System content blocks to append. Text-only. - `Type type` - `String text` The text content. minLength: 1 - `Metadata metadata` Arbitrary key-value metadata. Maximum 16 pairs. - `String name` Human-readable name. - `Optional pausedReason` Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise. - `class BetaManagedAgentsManualDeploymentPausedReason` The caller invoked the pause endpoint on the deployment. - `Type type` - `class BetaManagedAgentsErrorDeploymentPausedReason` A scheduled fire recorded a failed run whose error auto-pauses the deployment. - `Type type` - `BetaManagedAgentsDeploymentPausedReasonError error` The failed run's error. - `class BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError` The deployment's environment was archived. - `Type type` - `class BetaManagedAgentsAgentArchivedDeploymentPausedReasonError` The deployment's agent was archived. - `Type type` - `class BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError` The deployment's environment no longer exists. - `Type type` - `class BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError` A vault referenced by the deployment no longer exists. - `Type type` - `class BetaManagedAgentsFileNotFoundDeploymentPausedReasonError` A file resource referenced by the deployment no longer exists. - `Type type` - `class BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError` A referenced resource no longer exists and its kind was not reported. - `Type type` - `class BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError` The deployment's workspace was archived. - `Type type` - `class BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError` The deployment's organization is disabled. - `Type type` - `class BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError` A memory store referenced by the deployment is archived. - `Type type` - `class BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError` A skill referenced by the deployment's agent no longer exists. - `Type type` - `class BetaManagedAgentsVaultArchivedDeploymentPausedReasonError` A vault referenced by the deployment is archived. - `Type type` - `class BetaManagedAgentsUnknownDeploymentPausedReasonError` An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `Type type` - `class BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `Type type` - `class BetaManagedAgentsMcpEgressBlockedDeploymentPausedReasonError` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `Type type` - `List resources` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - `class BetaManagedAgentsGitHubRepositoryResourceConfig` A GitHub repository mounted into each session's container. The authorization token is write-only and never returned. - `Type type` - `String url` Github URL of the repository - `Optional checkout` Branch or commit to check out. Defaults to the repository's default branch. - `class BetaManagedAgentsBranchCheckout` - `Type type` - `String name` Branch name to check out. minLength: 1, maxLength: 255 - `class BetaManagedAgentsCommitCheckout` - `Type type` - `String sha` Full commit SHA to check out. minLength: 7, maxLength: 64 - `Optional mountPath` Mount path in the container. Defaults to `/workspace/`. - `class BetaManagedAgentsFileResourceConfig` A file mounted into each session's container. - `Type type` - `String fileId` ID of a previously uploaded file. - `Optional mountPath` Mount path in the container. Defaults to `/mnt/session/uploads/`. - `class BetaManagedAgentsMemoryStoreResourceConfig` A memory store attached to each session created from this deployment. - `Type type` - `String memoryStoreId` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `Optional access` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `READ_WRITE("read_write")` - `READ_ONLY("read_only")` - `Optional instructions` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `Optional schedule` Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant. - `Type type` - `String expression` 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 - `String timezone` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). minLength: 1 - `Optional lastRunAt` 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 - `Optional> upcomingRunsAt` 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. - `BetaManagedAgentsDeploymentStatus status` Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set. - `ACTIVE("active")` The deployment is active and can run sessions. Archived deployments also report this status; check `archived_at` to distinguish them. - `PAUSED("paused")` The deployment is paused. Autonomous triggers are suppressed; manual runs are still permitted. - `LocalDateTime updatedAt` Time the deployment was last updated. format: date-time - `List vaultIds` Vault IDs supplying stored credentials for sessions created from this deployment. - `Optional budget` Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set. - `Type type` - `BetaMonetaryAmount maxListCost` 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. - `String amount` 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. - `BetaCurrency currency` 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 ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.deployments.BetaManagedAgentsDeployment; import com.anthropic.models.beta.deployments.DeploymentArchiveParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaManagedAgentsDeployment betaManagedAgentsDeployment = client.beta().deployments().archive("depl_011CZkZcDH3vPqd7xnEfwTai"); } } ``` ### 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" } } ```