SPB Git
spboucher.ai

Repository Public

spbdoc-api

list.md 18.8 KB

# title: List Deployments url: https://platform.claude.com/docs/en/api/beta/deployments/list

# List Deployments

GET /v1/deployments

List Deployments

# Query parameters

  • agent_id: optional string

    Filter by agent ID.

  • "created_at[gte]": optional string

    Return deployments created at or after this time (inclusive).

    format: date-time

  • "created_at[lte]": optional string

    Return deployments created at or before this time (inclusive).

    format: date-time

  • include_archived: optional boolean

    When true, includes archived deployments. Default: false (exclude archived).

  • limit: optional number

    Maximum results per page. Default 20, maximum 100.

    format: int32

  • page: optional string

    Opaque pagination cursor.

  • status: optional BetaManagedAgentsDeploymentStatus

    Filter by status: active or paused. Omit for both. To include archived deployments, use include_archived instead; the two cannot be combined.

    • "active"

    • "paused"

# Headers

  • "anthropic-beta": optional array of AnthropicBeta

    Optional header to specify the beta version(s) you want to use.

    • string

    • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more

      • "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"

  • "anthropic-workspace-id": optional string

# Returns

  • data: array of BetaManagedAgentsDeployment

    List of deployments.

    • type: "deployment"

    • id: string

      Unique identifier for this deployment.

    • agent: BetaManagedAgentsAgentReference

      A resolved agent reference with a concrete version.

      • type: "agent"

      • id: string

      • 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.

    • environment_id: string

      ID of the environment where sessions run.

    • initial_events: array of BetaManagedAgentsDeploymentInitialEvent

      Events sent to each session immediately after creation.

      • BetaManagedAgentsDeploymentUserMessageEvent object

        A user message sent to the session.

        • type: "user.message"

        • content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock

          Array of content blocks for the user message.

          • BetaManagedAgentsTextBlock object

            Regular text content.

            • type: "text"

            • text: string

              The text content.

              minLength: 1

          • BetaManagedAgentsImageBlock object

            Image content specified directly as base64 data or as a reference via a URL.

            • type: "image"

            • source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource

              Union type for image source variants.

              • BetaManagedAgentsBase64ImageSource object

                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

              • BetaManagedAgentsURLImageSource object

                Image referenced by URL.

                • type: "url"

                • url: string

                  URL of the image to fetch.

                  minLength: 1

              • BetaManagedAgentsFileImageSource object

                Image referenced by file ID.

                • type: "file"

                • file_id: string

                  ID of a previously uploaded file.

                  minLength: 1

          • BetaManagedAgentsDocumentBlock object

            Document content, either specified directly as base64 data, as text, or as a reference via a URL.

            • type: "document"

            • source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource

              Union type for document source variants.

              • BetaManagedAgentsBase64DocumentSource object

                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

              • BetaManagedAgentsPlainTextDocumentSource object

                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".

              • BetaManagedAgentsURLDocumentSource object

                Document referenced by URL.

                • type: "url"

                • url: string

                  URL of the document to fetch.

                  minLength: 1

              • BetaManagedAgentsFileDocumentSource object

                Document referenced by file ID.

                • type: "file"

                • file_id: string

                  ID of a previously uploaded file.

                  minLength: 1

            • context: optional string or null

              Additional context about the document for the model.

            • title: optional string or null

              The title of the document.

          • BetaManagedAgentsRedactedBlock object

            Placeholder for content withheld by Anthropic model policy.

            • type: "redacted"

      • BetaManagedAgentsDeploymentUserDefineOutcomeEvent object

        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 or BetaManagedAgentsTextRubric

          Rubric for grading the quality of an outcome.

          • BetaManagedAgentsFileRubric object

            Rubric referenced by a file uploaded via the Files API.

            • type: "file"

            • file_id: string

              ID of the rubric file.

          • BetaManagedAgentsTextRubric object

            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: optional number or null

          Eval→revision cycles before giving up. Default 3, max 20.

          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.

        • type: "system.message"

        • content: array of BetaManagedAgentsSystemContentBlock

          System content blocks to append. Text-only.

          • type: "text"

          • text: string

            The text content.

            minLength: 1

    • metadata: map[string]

      Arbitrary key-value metadata. Maximum 16 pairs.

    • name: string

      Human-readable name.

    • paused_reason: BetaManagedAgentsDeploymentPausedReason or null

      Why a deployment is paused. Non-null exactly when status is paused.

      • BetaManagedAgentsManualDeploymentPausedReason object

        The caller invoked the pause endpoint on the deployment.

        • type: "manual"

      • BetaManagedAgentsErrorDeploymentPausedReason object

        A scheduled fire recorded a failed run whose error auto-pauses the deployment.

        • type: "error"

        • error: BetaManagedAgentsDeploymentPausedReasonError

          The error that triggered an auto-pause. Matches the failed run's error.type.

          • BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object

            The deployment's environment was archived.

            • type: "environment_archived_error"

          • BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object

            The deployment's agent was archived.

            • type: "agent_archived_error"

          • BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object

            The deployment's environment no longer exists.

            • type: "environment_not_found_error"

          • BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object

            A vault referenced by the deployment no longer exists.

            • type: "vault_not_found_error"

          • BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object

            A file resource referenced by the deployment no longer exists.

            • type: "file_not_found_error"

          • BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object

            A referenced resource no longer exists and its kind was not reported.

            • type: "session_resource_not_found_error"

          • BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object

            The deployment's workspace was archived.

            • type: "workspace_archived_error"

          • BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object

            The deployment's organization is disabled.

            • type: "organization_disabled_error"

          • BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object

            A memory store referenced by the deployment is archived.

            • type: "memory_store_archived_error"

          • BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object

            A skill referenced by the deployment's agent no longer exists.

            • type: "skill_not_found_error"

          • BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object

            A vault referenced by the deployment is archived.

            • type: "vault_archived_error"

          • BetaManagedAgentsUnknownDeploymentPausedReasonError object

            An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose error.type is unknown_error.

            • type: "unknown_error"

          • BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object

            The deployment configures resources, but its environment is self-hosted and cannot mount them.

            • type: "self_hosted_resources_unsupported_error"

          • BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object

            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 of BetaManagedAgentsSessionResourceConfig

      Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.

      • BetaManagedAgentsGitHubRepositoryResourceConfig object

        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: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null

          Branch or commit to check out. Defaults to the repository's default branch.

          • BetaManagedAgentsBranchCheckout object

            • type: "branch"

            • name: string

              Branch name to check out.

              minLength: 1, maxLength: 255

          • BetaManagedAgentsCommitCheckout object

            • type: "commit"

            • sha: string

              Full commit SHA to check out.

              minLength: 7, maxLength: 64

        • mount_path: optional string or null

          Mount path in the container. Defaults to /workspace/<repo-name>.

      • BetaManagedAgentsFileResourceConfig object

        A file mounted into each session's container.

        • type: "file"

        • file_id: string

          ID of a previously uploaded file.

        • mount_path: optional string or null

          Mount path in the container. Defaults to /mnt/session/uploads/<file_id>.

      • BetaManagedAgentsMemoryStoreResourceConfig object

        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: optional "read_write" or "read_only" or null

          Access mode for an attached memory store.

          • "read_write"

          • "read_only"

        • instructions: optional string or 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 or null

      5-field POSIX cron schedule with computed runtime timestamps.

      • 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: 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.

    • status: BetaManagedAgentsDeploymentStatus

      Lifecycle status of a deployment.

      • "active"

      • "paused"

    • 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.

    • budget: optional BetaManagedAgentsBudgetLimit or null

      A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches max_list_cost.

      • type: "limit"

      • max_list_cost: BetaMonetaryAmount

        A monetary amount in a specific currency.

        • 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.

  • next_page: optional string or null

    Opaque cursor for the next page. Null when no more results.

# Example

bash
curl https://api.anthropic.com/v1/deployments \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: managed-agents-2026-04-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

# Response (200)

json
{
  "data": [
    {
      "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"
      }
    }
  ],
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
Files main
Menu

Theme
↑↓navigate ↵open escclose /⌘Kanywhere