One change
Run Deployment Now
api/beta/deployments/run
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/run Changed · +36 / -75 lines
# Run Deployment Now ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Run Deployment Now ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
---- -title: Run Deployment Now -url: https://platform.claude.com/docs/en/api/beta/deployments/run ---- +# Run Deployment Now -## Run Deployment Now +**POST** `/v1/deployments/{deployment_id}/run` -**post** `/v1/deployments/{deployment_id}/run` - Run Deployment Now -### 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 -- `BetaManagedAgentsDeploymentRun object { id, agent, created_at, 5 more }` +- `BetaManagedAgentsDeploymentRun object` A persistent, append-only record of a single deployment execution. Records session creation success or failure — no session lifecycle tracking.
from line 104
- `type: "agent"` - - `"agent"` - - `version: number` + format: int32 + - `created_at: string` A timestamp in RFC 3339 format + format: date-time + - `deployment_id: string` ID of the deployment that produced this run.
from line 122
Why the run failed to create a session. The type identifies the failure; message is human-readable detail. - - `BetaManagedAgentsEnvironmentArchivedRunError object { message, type }` + - `BetaManagedAgentsEnvironmentArchivedRunError object` The deployment's environment was archived.
from line 132
- `type: "environment_archived_error"` - - `"environment_archived_error"` + - `BetaManagedAgentsAgentArchivedRunError object` - - `BetaManagedAgentsAgentArchivedRunError object { message, type }` - The deployment's agent was archived. - `message: string`
from line 142
- `type: "agent_archived_error"` - - `"agent_archived_error"` + - `BetaManagedAgentsEnvironmentNotFoundRunError object` - - `BetaManagedAgentsEnvironmentNotFoundRunError object { message, type }` - The deployment's environment no longer exists. - `message: string`
from line 152
- `type: "environment_not_found_error"` - - `"environment_not_found_error"` + - `BetaManagedAgentsVaultNotFoundRunError object` - - `BetaManagedAgentsVaultNotFoundRunError object { message, type }` - A vault referenced by the deployment no longer exists. - `message: string`
from line 162
- `type: "vault_not_found_error"` - - `"vault_not_found_error"` + - `BetaManagedAgentsVaultArchivedRunError object` - - `BetaManagedAgentsVaultArchivedRunError object { message, type }` - A vault referenced by the deployment is archived. - `message: string`
from line 172
- `type: "vault_archived_error"` - - `"vault_archived_error"` + - `BetaManagedAgentsFileNotFoundRunError object` - - `BetaManagedAgentsFileNotFoundRunError object { message, type }` - A file resource referenced by the deployment no longer exists. - `message: string`
from line 182
- `type: "file_not_found_error"` - - `"file_not_found_error"` + - `BetaManagedAgentsMemoryStoreArchivedRunError object` - - `BetaManagedAgentsMemoryStoreArchivedRunError object { message, type }` - A memory store referenced by the deployment is archived. - `message: string`
from line 192
- `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` + - `BetaManagedAgentsSkillNotFoundRunError object` - - `BetaManagedAgentsSkillNotFoundRunError object { message, type }` - A skill referenced by the deployment's agent no longer exists. - `message: string`
from line 202
- `type: "skill_not_found_error"` - - `"skill_not_found_error"` + - `BetaManagedAgentsSessionResourceNotFoundRunError object` - - `BetaManagedAgentsSessionResourceNotFoundRunError object { message, type }` - A referenced resource no longer exists and its kind was not reported. - `message: string`
from line 212
- `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` + - `BetaManagedAgentsWorkspaceArchivedRunError object` - - `BetaManagedAgentsWorkspaceArchivedRunError object { message, type }` - The deployment's workspace was archived. - `message: string`
from line 222
- `type: "workspace_archived_error"` - - `"workspace_archived_error"` + - `BetaManagedAgentsOrganizationDisabledRunError object` - - `BetaManagedAgentsOrganizationDisabledRunError object { message, type }` - The deployment's organization is disabled. - `message: string`
from line 232
- `type: "organization_disabled_error"` - - `"organization_disabled_error"` + - `BetaManagedAgentsSessionRateLimitedRunError object` - - `BetaManagedAgentsSessionRateLimitedRunError object { message, type }` - Session creation was rejected due to rate limiting. The schedule keeps firing; subsequent runs may succeed. - `message: string`
from line 242
- `type: "session_rate_limited_error"` - - `"session_rate_limited_error"` + - `BetaManagedAgentsSessionCreationRejectedRunError object` - - `BetaManagedAgentsSessionCreationRejectedRunError object { message, type }` - The session create request was rejected with a non-retryable validation error. - `message: string`
from line 252
- `type: "session_creation_rejected_error"` - - `"session_creation_rejected_error"` + - `BetaManagedAgentsUnknownRunError object` - - `BetaManagedAgentsUnknownRunError object { message, type }` - An unknown or unexpected error caused the run to fail. A fallback variant; clients that do not recognize a new error type can match on message alone. - `message: string`
from line 262
- `type: "unknown_error"` - - `"unknown_error"` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedRunError object` - - `BetaManagedAgentsSelfHostedResourcesUnsupportedRunError object { message, type }` - The deployment configures resources, but its environment is self-hosted and cannot mount them. - `message: string`
from line 272
- `type: "self_hosted_resources_unsupported_error"` - - `"self_hosted_resources_unsupported_error"` + - `BetaManagedAgentsMCPEgressBlockedRunError object` - - `BetaManagedAgentsMCPEgressBlockedRunError object { message, type }` - An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `message: string`
from line 282
- `type: "mcp_egress_blocked_error"` - - `"mcp_egress_blocked_error"` - - `session_id: string or null` Populated on success. Null on creation failure. Exactly one of session_id or error is non-null.
from line 290
Describes what triggered a deployment run, with trigger-specific metadata. - - `BetaManagedAgentsScheduleTriggerContext object { scheduled_at, type }` + - `BetaManagedAgentsScheduleTriggerContext object` The run was fired by the deployment's cron schedule.
from line 298
A timestamp in RFC 3339 format + format: date-time + - `type: "schedule"` - - `"schedule"` + - `BetaManagedAgentsManualTriggerContext object` - - `BetaManagedAgentsManualTriggerContext object { type }` - The run was started manually by creating a session directly against the deployment. - `type: "manual"` - - `"manual"` - - `type: "deployment_run"` - - `"deployment_run"` +## Example -### Example - -```http +```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/run \ -X POST \ -H 'anthropic-version: 2023-06-01' \
from line 320
-H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +### Response (200) ```json {