One change
Archive Deployment
api/beta/deployments/archive
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/beta/deployments/archive Changed · +91 / -142 lines
# Archive Deployment ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Archive Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
---- -title: Archive Deployment -url: https://platform.claude.com/docs/en/api/beta/deployments/archive ---- +# Archive Deployment -## Archive Deployment +**POST** `/v1/deployments/{deployment_id}/archive` -**post** `/v1/deployments/{deployment_id}/archive` - Archive Deployment -### Path Parameters +## Path parameters - `deployment_id: string` -### Header Parameters +## Headers - `"anthropic-beta": optional array of AnthropicBeta`
from line 86
- `"mid-conversation-tool-changes-2026-07-01"` -### Returns +## Returns -- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }` +- `BetaManagedAgentsDeployment object` 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.
from line 104
- `type: "agent"` - - `"agent"` - - `version: number` + format: int32 + - `archived_at: string or null` A timestamp in RFC 3339 format + format: date-time + - `created_at: string` A timestamp in RFC 3339 format + format: date-time + - `description: string or null` Description of what the deployment does.
from line 132
Events sent to each session immediately after creation. - - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }` + - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session.
from line 140
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 148
The text content. + minLength: 1 + - `type: "text"` - - `"text"` + - `BetaManagedAgentsImageBlock object` - - `BetaManagedAgentsImageBlock object { source, type }` - Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
from line 160
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 168
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 + - `type: "base64"` - - `"base64"` + - `BetaManagedAgentsURLImageSource object` - - `BetaManagedAgentsURLImageSource object { type, url }` - Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + - `BetaManagedAgentsFileImageSource object` + Image referenced by file ID. - `file_id: string`
from line 198
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` + - `BetaManagedAgentsDocumentBlock object` - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` - Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
from line 212
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 220
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` + - `BetaManagedAgentsPlainTextDocumentSource object` - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` - Plain text document content. - `data: string`
from line 238
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` + - `BetaManagedAgentsURLDocumentSource object` - - `BetaManagedAgentsURLDocumentSource object { type, url }` - Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + - `BetaManagedAgentsFileDocumentSource object` + Document referenced by file ID. - `file_id: string`
from line 266
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 280
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` + - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` - - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }` - An outcome the agent should work toward. The agent begins work on receipt. - `description: string`
from line 300
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubric object { file_id, type }` + - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API.
from line 310
- `type: "file"` - - `"file"` + - `BetaManagedAgentsTextRubric object` - - `BetaManagedAgentsTextRubric object { content, type }` - Rubric content provided inline as text. - `content: string`
from line 320
- `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }` + format: int32 + - `BetaManagedAgentsDeploymentSystemMessageEvent 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. - `content: array of BetaManagedAgentsSystemContentBlock`
from line 340
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs.
from line 358
Why a deployment is paused. Non-null exactly when `status` is `paused`. - - `BetaManagedAgentsManualDeploymentPausedReason object { type }` + - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - - `"manual"` + - `BetaManagedAgentsErrorDeploymentPausedReason object` - - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }` - A scheduled fire recorded a failed run whose error auto-pauses the deployment. - `error: BetaManagedAgentsDeploymentPausedReasonError`
from line 372
The error that triggered an auto-pause. Matches the failed run's `error.type`. - - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` + - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` - - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` - The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` + - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` - - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` - The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` + - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` - - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` - A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` + - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` - - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` - A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` + - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` - - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` - A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` + - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` - - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` - The deployment's workspace was archived. - `type: "workspace_archived_error"` - - `"workspace_archived_error"` + - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` - - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` - The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` + - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` - - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` - A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` + - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` - - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` - A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` + - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` - - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` - A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` + - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` - - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` - An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `type: "unknown_error"` - - `"unknown_error"` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` - - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }` - The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - - `"self_hosted_resources_unsupported_error"` + - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` - - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }` - An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - - `"mcp_egress_blocked_error"` - - `type: "error"` - - `"error"` - - `resources: array of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }` + - `BetaManagedAgentsGitHubRepositoryResourceConfig object` A GitHub repository mounted into each session's container. The authorization token is write-only and never returned. - `type: "github_repository"` - - `"github_repository"` - - `url: string` Github URL of the repository
from line 476
Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` + - `BetaManagedAgentsCommitCheckout object` - - `BetaManagedAgentsCommitCheckout object { sha, type }` - - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. - - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }` + - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container.
from line 510
- `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }` + - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment.
from line 524
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 544
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 + - `type: "cron"` - - `"cron"` - - `last_run_at: optional string or null` A timestamp in RFC 3339 format + format: date-time + - `upcoming_runs_at: optional array of 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.
from line 574
- `type: "deployment"` - - `"deployment"` - - `updated_at: string` A timestamp in RFC 3339 format + format: date-time + - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment.
from line 600
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. - - `"USD"` - - `type: "limit"` - - `"limit"` +## Example -### Example - -```http +```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \
from line 612
-H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +### Response (200) ```json {