Repository Public
1---2title: List Deployments3url: https://platform.claude.com/docs/en/api/beta/deployments/list4---56# List Deployments78**GET** `/v1/deployments`910List Deployments1112## Query parameters1314- `agent_id: optional string`1516 Filter by agent ID.1718- `"created_at[gte]": optional string`1920 Return deployments created at or after this time (inclusive).2122 format: date-time2324- `"created_at[lte]": optional string`2526 Return deployments created at or before this time (inclusive).2728 format: date-time2930- `include_archived: optional boolean`3132 When true, includes archived deployments. Default: false (exclude archived).3334- `limit: optional number`3536 Maximum results per page. Default 20, maximum 100.3738 format: int323940- `page: optional string`4142 Opaque pagination cursor.4344- `status: optional BetaManagedAgentsDeploymentStatus`4546 Filter by status: `active` or `paused`. Omit for both. To include archived deployments, use `include_archived` instead; the two cannot be combined.4748 - `"active"`4950 - `"paused"`5152## Headers5354- `"anthropic-beta": optional array of AnthropicBeta`5556 Optional header to specify the beta version(s) you want to use.5758 - `string`5960 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`6162 - `"message-batches-2024-09-24"`6364 - `"prompt-caching-2024-07-31"`6566 - `"computer-use-2024-10-22"`6768 - `"computer-use-2025-01-24"`6970 - `"pdfs-2024-09-25"`7172 - `"token-counting-2024-11-01"`7374 - `"token-efficient-tools-2025-02-19"`7576 - `"output-128k-2025-02-19"`7778 - `"files-api-2025-04-14"`7980 - `"mcp-client-2025-04-04"`8182 - `"mcp-client-2025-11-20"`8384 - `"dev-full-thinking-2025-05-14"`8586 - `"interleaved-thinking-2025-05-14"`8788 - `"code-execution-2025-05-22"`8990 - `"extended-cache-ttl-2025-04-11"`9192 - `"context-1m-2025-08-07"`9394 - `"context-management-2025-06-27"`9596 - `"model-context-window-exceeded-2025-08-26"`9798 - `"skills-2025-10-02"`99100 - `"fast-mode-2026-02-01"`101102 - `"output-300k-2026-03-24"`103104 - `"user-profiles-2026-03-24"`105106 - `"user-profiles-2026-08-18"`107108 - `"user-profiles-2026-09-04"`109110 - `"advisor-tool-2026-03-01"`111112 - `"managed-agents-2026-04-01"`113114 - `"cache-diagnosis-2026-04-07"`115116 - `"dreaming-2026-04-21"`117118 - `"thinking-token-count-2026-05-13"`119120 - `"server-side-fallback-2026-06-01"`121122 - `"server-side-fallback-2026-07-01"`123124 - `"fallback-credit-2026-06-01"`125126 - `"fallback-credit-2026-07-01"`127128 - `"agent-memory-2026-07-22"`129130 - `"mid-conversation-tool-changes-2026-07-01"`131132 - `"compact-2026-01-12"`133134 - `"computer-use-2025-11-24"`135136 - `"mcp-tunnels-2026-06-22"`137138 - `"structured-outputs-2025-11-13"`139140 - `"task-budgets-2026-03-13"`141142 - `"thinking-display-updates-2026-08-18"`143144 - `"ce-user-management-2026-07-13"`145146 - `"mid-conversation-output-config-2026-07-01"`147148 - `"thinking-binding-controls-2026-08-01"`149150 - `"mid-conversation-system-clear-at-2026-08-21"`151152 - `"compact-2026-09-04"`153154- `"anthropic-workspace-id": optional string`155156## Returns157158- `data: array of BetaManagedAgentsDeployment`159160 List of deployments.161162 - `type: "deployment"`163164 - `id: string`165166 Unique identifier for this deployment.167168 - `agent: BetaManagedAgentsAgentReference`169170 A resolved agent reference with a concrete version.171172 - `type: "agent"`173174 - `id: string`175176 - `version: number`177178 format: int32179180 - `archived_at: string or null`181182 A timestamp in RFC 3339 format183184 format: date-time185186 - `created_at: string`187188 A timestamp in RFC 3339 format189190 format: date-time191192 - `description: string or null`193194 Description of what the deployment does.195196 - `environment_id: string`197198 ID of the `environment` where sessions run.199200 - `initial_events: array of BetaManagedAgentsDeploymentInitialEvent`201202 Events sent to each session immediately after creation.203204 - `BetaManagedAgentsDeploymentUserMessageEvent object`205206 A user message sent to the session.207208 - `type: "user.message"`209210 - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`211212 Array of content blocks for the user message.213214 - `BetaManagedAgentsTextBlock object`215216 Regular text content.217218 - `type: "text"`219220 - `text: string`221222 The text content.223224 minLength: 1225226 - `BetaManagedAgentsImageBlock object`227228 Image content specified directly as base64 data or as a reference via a URL.229230 - `type: "image"`231232 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`233234 Union type for image source variants.235236 - `BetaManagedAgentsBase64ImageSource object`237238 Base64-encoded image data.239240 - `type: "base64"`241242 - `data: string`243244 Base64-encoded image data.245246 minLength: 1247248 - `media_type: string`249250 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").251252 minLength: 1253254 - `BetaManagedAgentsURLImageSource object`255256 Image referenced by URL.257258 - `type: "url"`259260 - `url: string`261262 URL of the image to fetch.263264 minLength: 1265266 - `BetaManagedAgentsFileImageSource object`267268 Image referenced by file ID.269270 - `type: "file"`271272 - `file_id: string`273274 ID of a previously uploaded file.275276 minLength: 1277278 - `BetaManagedAgentsDocumentBlock object`279280 Document content, either specified directly as base64 data, as text, or as a reference via a URL.281282 - `type: "document"`283284 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`285286 Union type for document source variants.287288 - `BetaManagedAgentsBase64DocumentSource object`289290 Base64-encoded document data.291292 - `type: "base64"`293294 - `data: string`295296 Base64-encoded document data.297298 minLength: 1299300 - `media_type: string`301302 MIME type of the document (e.g., "application/pdf").303304 minLength: 1305306 - `BetaManagedAgentsPlainTextDocumentSource object`307308 Plain text document content.309310 - `type: "text"`311312 - `data: string`313314 The plain text content.315316 minLength: 1317318 - `media_type: "text/plain"`319320 MIME type of the text content. Must be "text/plain".321322 - `BetaManagedAgentsURLDocumentSource object`323324 Document referenced by URL.325326 - `type: "url"`327328 - `url: string`329330 URL of the document to fetch.331332 minLength: 1333334 - `BetaManagedAgentsFileDocumentSource object`335336 Document referenced by file ID.337338 - `type: "file"`339340 - `file_id: string`341342 ID of a previously uploaded file.343344 minLength: 1345346 - `context: optional string or null`347348 Additional context about the document for the model.349350 - `title: optional string or null`351352 The title of the document.353354 - `BetaManagedAgentsRedactedBlock object`355356 Placeholder for content withheld by Anthropic model policy.357358 - `type: "redacted"`359360 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`361362 An outcome the agent should work toward. The agent begins work on receipt.363364 - `type: "user.define_outcome"`365366 - `description: string`367368 What the agent should produce. This is the task specification.369370 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`371372 Rubric for grading the quality of an outcome.373374 - `BetaManagedAgentsFileRubric object`375376 Rubric referenced by a file uploaded via the Files API.377378 - `type: "file"`379380 - `file_id: string`381382 ID of the rubric file.383384 - `BetaManagedAgentsTextRubric object`385386 Rubric content provided inline as text.387388 - `type: "text"`389390 - `content: string`391392 Rubric content. Plain text or markdown — the grader treats it as freeform text.393394 - `max_iterations: optional number or null`395396 Eval→revision cycles before giving up. Default 3, max 20.397398 format: int32399400 - `BetaManagedAgentsDeploymentSystemMessageEvent object`401402 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.403404 - `type: "system.message"`405406 - `content: array of BetaManagedAgentsSystemContentBlock`407408 System content blocks to append. Text-only.409410 - `type: "text"`411412 - `text: string`413414 The text content.415416 minLength: 1417418 - `metadata: map[string]`419420 Arbitrary key-value metadata. Maximum 16 pairs.421422 - `name: string`423424 Human-readable name.425426 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`427428 Why a deployment is paused. Non-null exactly when `status` is `paused`.429430 - `BetaManagedAgentsManualDeploymentPausedReason object`431432 The caller invoked the pause endpoint on the deployment.433434 - `type: "manual"`435436 - `BetaManagedAgentsErrorDeploymentPausedReason object`437438 A scheduled fire recorded a failed run whose error auto-pauses the deployment.439440 - `type: "error"`441442 - `error: BetaManagedAgentsDeploymentPausedReasonError`443444 The error that triggered an auto-pause. Matches the failed run's `error.type`.445446 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`447448 The deployment's environment was archived.449450 - `type: "environment_archived_error"`451452 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`453454 The deployment's agent was archived.455456 - `type: "agent_archived_error"`457458 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`459460 The deployment's environment no longer exists.461462 - `type: "environment_not_found_error"`463464 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`465466 A vault referenced by the deployment no longer exists.467468 - `type: "vault_not_found_error"`469470 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`471472 A file resource referenced by the deployment no longer exists.473474 - `type: "file_not_found_error"`475476 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`477478 A referenced resource no longer exists and its kind was not reported.479480 - `type: "session_resource_not_found_error"`481482 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`483484 The deployment's workspace was archived.485486 - `type: "workspace_archived_error"`487488 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`489490 The deployment's organization is disabled.491492 - `type: "organization_disabled_error"`493494 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`495496 A memory store referenced by the deployment is archived.497498 - `type: "memory_store_archived_error"`499500 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`501502 A skill referenced by the deployment's agent no longer exists.503504 - `type: "skill_not_found_error"`505506 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`507508 A vault referenced by the deployment is archived.509510 - `type: "vault_archived_error"`511512 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`513514 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.515516 - `type: "unknown_error"`517518 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`519520 The deployment configures resources, but its environment is self-hosted and cannot mount them.521522 - `type: "self_hosted_resources_unsupported_error"`523524 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`525526 An MCP server host used by the deployment's agent is blocked by the environment's network policy.527528 - `type: "mcp_egress_blocked_error"`529530 - `resources: array of BetaManagedAgentsSessionResourceConfig`531532 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.533534 - `BetaManagedAgentsGitHubRepositoryResourceConfig object`535536 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.537538 - `type: "github_repository"`539540 - `url: string`541542 Github URL of the repository543544 - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null`545546 Branch or commit to check out. Defaults to the repository's default branch.547548 - `BetaManagedAgentsBranchCheckout object`549550 - `type: "branch"`551552 - `name: string`553554 Branch name to check out.555556 minLength: 1, maxLength: 255557558 - `BetaManagedAgentsCommitCheckout object`559560 - `type: "commit"`561562 - `sha: string`563564 Full commit SHA to check out.565566 minLength: 7, maxLength: 64567568 - `mount_path: optional string or null`569570 Mount path in the container. Defaults to `/workspace/<repo-name>`.571572 - `BetaManagedAgentsFileResourceConfig object`573574 A file mounted into each session's container.575576 - `type: "file"`577578 - `file_id: string`579580 ID of a previously uploaded file.581582 - `mount_path: optional string or null`583584 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.585586 - `BetaManagedAgentsMemoryStoreResourceConfig object`587588 A memory store attached to each session created from this deployment.589590 - `type: "memory_store"`591592 - `memory_store_id: string`593594 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.595596 - `access: optional "read_write" or "read_only" or null`597598 Access mode for an attached memory store.599600 - `"read_write"`601602 - `"read_only"`603604 - `instructions: optional string or null`605606 Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.607608 - `schedule: BetaManagedAgentsSchedule or null`609610 5-field POSIX cron schedule with computed runtime timestamps.611612 - `type: "cron"`613614 - `expression: string`615616 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).617618 minLength: 1, maxLength: 256619620 - `timezone: string`621622 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").623624 minLength: 1625626 - `last_run_at: optional string or null`627628 A timestamp in RFC 3339 format629630 format: date-time631632 - `upcoming_runs_at: optional array of string`633634 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.635636 - `status: BetaManagedAgentsDeploymentStatus`637638 Lifecycle status of a deployment.639640 - `"active"`641642 - `"paused"`643644 - `updated_at: string`645646 A timestamp in RFC 3339 format647648 format: date-time649650 - `vault_ids: array of string`651652 Vault IDs supplying stored credentials for sessions created from this deployment.653654 - `budget: optional BetaManagedAgentsBudgetLimit or null`655656 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.657658 - `type: "limit"`659660 - `max_list_cost: BetaMonetaryAmount`661662 A monetary amount in a specific currency.663664 - `amount: string`665666 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.667668 - `currency: BetaCurrency`669670 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.671672- `next_page: optional string or null`673674 Opaque cursor for the next page. Null when no more results.675676## Example677678```bash679curl https://api.anthropic.com/v1/deployments \680 -H 'anthropic-version: 2023-06-01' \681 -H 'anthropic-beta: managed-agents-2026-04-01' \682 -H "X-Api-Key: $ANTHROPIC_API_KEY"683```684685### Response (200)686687```json688{689 "data": [690 {691 "id": "depl_011CZkZcDH3vPqd7xnEfwTai",692 "agent": {693 "id": "agent_011CZkYpogX7uDKUyvBTophP",694 "type": "agent",695 "version": 1696 },697 "archived_at": null,698 "created_at": "2026-03-15T10:00:00Z",699 "description": "Compiles yesterday's orders into a report every weekday morning.",700 "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW",701 "initial_events": [702 {703 "content": [704 {705 "text": "Compile yesterday's orders into report.md.",706 "type": "text"707 }708 ],709 "type": "user.message"710 }711 ],712 "metadata": {},713 "name": "Daily order report",714 "paused_reason": {715 "type": "manual"716 },717 "resources": [718 {719 "type": "github_repository",720 "url": "url",721 "checkout": {722 "name": "main",723 "type": "branch"724 },725 "mount_path": "mount_path"726 }727 ],728 "schedule": {729 "expression": "0 9 * * 1-5",730 "timezone": "America/Los_Angeles",731 "type": "cron",732 "last_run_at": "2026-03-16T16:00:09Z",733 "upcoming_runs_at": [734 "2026-03-17T16:00:00Z",735 "2026-03-18T16:00:00Z"736 ]737 },738 "status": "active",739 "type": "deployment",740 "updated_at": "2026-03-15T10:00:00Z",741 "vault_ids": [742 "vlt_011CZkZDLs7fYzm1hXNPeRjv"743 ],744 "budget": {745 "max_list_cost": {746 "amount": "2500",747 "currency": "USD"748 },749 "type": "limit"750 }751 }752 ],753 "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="754}755```756