Beta › Vaults › Credentials
Create Credential
POST /v1/vaults/\{vault_id\}/credentials
Create Credential
Path parameters
vault_id: string
Headers
"anthropic-beta": optional array of AnthropicBetaOptional 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 42 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"
"anthropic-workspace-id": optional string
Body parameters
auth: BetaManagedAgentsMCPOAuthCreateParams or BetaManagedAgentsStaticBearerCreateParams or BetaManagedAgentsEnvironmentVariableCreateParamsAuthentication details for creating a credential.
BetaManagedAgentsMCPOAuthCreateParams objectParameters for creating an MCP OAuth credential.
type: "mcp_oauth"access_token: stringOAuth access token.
minLength: 1, maxLength: 8192
mcp_server_url: stringURL of the MCP server this credential authenticates against.
minLength: 1, maxLength: 2047
expires_at: optional string or nullA timestamp in RFC 3339 format
format: date-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshParams or nullOAuth refresh token parameters for creating a credential with refresh support.
client_id: stringOAuth client ID.
minLength: 1, maxLength: 1024
refresh_token: stringOAuth refresh token.
minLength: 1, maxLength: 8192
token_endpoint: stringToken endpoint URL used to refresh the access token.
minLength: 1, maxLength: 2047
token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneParam or BetaManagedAgentsTokenEndpointAuthBasicParam or BetaManagedAgentsTokenEndpointAuthPostParamToken endpoint requires no client authentication.
BetaManagedAgentsTokenEndpointAuthNoneParam objectToken endpoint requires no client authentication.
type: "none"
BetaManagedAgentsTokenEndpointAuthBasicParam objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"client_secret: stringOAuth client secret.
minLength: 1, maxLength: 512
BetaManagedAgentsTokenEndpointAuthPostParam objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"client_secret: stringOAuth client secret.
minLength: 1, maxLength: 512
resource: optional string or nullOAuth resource indicator.
minLength: 1, maxLength: 2047
scope: optional string or nullOAuth scope for the refresh request.
minLength: 1, maxLength: 8192
BetaManagedAgentsStaticBearerCreateParams objectParameters for creating a static bearer token credential.
type: "static_bearer"token: stringStatic bearer token value.
minLength: 1, maxLength: 8192
mcp_server_url: stringURL of the MCP server this credential authenticates against.
minLength: 1, maxLength: 2047
BetaManagedAgentsEnvironmentVariableCreateParams objectParameters for creating an environment variable credential.
type: "environment_variable"networking: BetaManagedAgentsCredentialNetworkingParamsOutbound hosts the secret value is substituted on.
BetaManagedAgentsUnrestrictedCredentialNetworkingParams objectSubstitute the secret on any host the session's Environment network policy permits egress to. The Environment's network policy is the only boundary on where the secret can reach.
type: "unrestricted"
BetaManagedAgentsLimitedCredentialNetworkingParams objectSubstitute the secret only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames on which the secret will be substituted. Each entry is a bare hostname (
api.example.com), an IPv4 address (192.0.2.1), or a*.-prefixed wildcard (*.example.com). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.
secret_name: stringName of the environment variable. Immutable after create.
minLength: 1, maxLength: 255
secret_value: stringSecret value. Write-only; never returned in responses.
minLength: 1, maxLength: 4096
injection_location: optional BetaManagedAgentsInjectionLocationParamsWhere in the outbound request the secret value may be substituted.
body: optional booleanSubstitute when the placeholder appears in the request body.
header: optional booleanSubstitute when the placeholder appears in a request header value.
display_name: optional string or nullHuman-readable name for the credential. Up to 255 characters.
maxLength: 255
metadata: optional map[string]Arbitrary key-value metadata to attach to the credential. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
Returns
BetaManagedAgentsCredential objectA credential stored in a vault. Sensitive fields are never returned in responses.
type: "vault_credential"id: stringUnique identifier for the credential.
archived_at: string or nullA timestamp in RFC 3339 format
format: date-time
auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse or BetaManagedAgentsEnvironmentVariableAuthResponseAuthentication details for a credential.
BetaManagedAgentsMCPOAuthAuthResponse objectOAuth credential details for an MCP server.
type: "mcp_oauth"mcp_server_url: stringURL of the MCP server this credential authenticates against.
expires_at: optional string or nullA timestamp in RFC 3339 format
format: date-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse or nullOAuth refresh token configuration returned in credential responses.
client_id: stringOAuth client ID.
token_endpoint: stringToken endpoint URL used to refresh the access token.
token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponseToken endpoint requires no client authentication.
BetaManagedAgentsTokenEndpointAuthNoneResponse objectToken endpoint requires no client authentication.
type: "none"
BetaManagedAgentsTokenEndpointAuthBasicResponse objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"
BetaManagedAgentsTokenEndpointAuthPostResponse objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"
resource: optional string or nullOAuth resource indicator.
scope: optional string or nullOAuth scope for the refresh request.
BetaManagedAgentsStaticBearerAuthResponse objectStatic bearer token credential details for an MCP server.
type: "static_bearer"mcp_server_url: stringURL of the MCP server this credential authenticates against.
BetaManagedAgentsEnvironmentVariableAuthResponse objectEnvironment variable credential details. The secret value is never returned.
type: "environment_variable"injection_location: BetaManagedAgentsInjectionLocationResponseWhere in the outbound request the secret value is substituted.
body: booleanWhether the placeholder is substituted in the request body.
header: booleanWhether the placeholder is substituted in request header values.
networking: BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponseOutbound hosts the secret value is substituted on.
BetaManagedAgentsUnrestrictedCredentialNetworkingResponse objectThe secret is substituted on any host the session's Environment network policy permits egress to.
type: "unrestricted"
BetaManagedAgentsLimitedCredentialNetworkingResponse objectThe secret is substituted only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames on which the secret will be substituted. An entry matches the request host exactly; a
*.-prefixed entry matches any subdomain of the named domain but not the domain itself.
secret_name: stringName of the environment variable.
created_at: stringA timestamp in RFC 3339 format
format: date-time
metadata: map[string]Arbitrary key-value metadata attached to the credential.
updated_at: stringA timestamp in RFC 3339 format
format: date-time
vault_id: stringIdentifier of the vault this credential belongs to.
display_name: optional string or nullHuman-readable name for the credential.
Example
curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"auth": {
"token": "bearer_exampletoken",
"mcp_server_url": "https://example-server.modelcontextprotocol.io/sse",
"type": "static_bearer"
},
"display_name": "Example credential",
"metadata": {
"environment": "production"
}
}'Response (200)
{
"id": "vcrd_011CZkZEMt8gZan2iYOQfSkw",
"archived_at": null,
"auth": {
"mcp_server_url": "https://example-server.modelcontextprotocol.io/sse",
"type": "static_bearer"
},
"created_at": "2026-03-15T10:00:00Z",
"metadata": {
"environment": "production"
},
"type": "vault_credential",
"updated_at": "2026-03-15T10:00:00Z",
"vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv",
"display_name": "Example credential"
}List Credentials
GET /v1/vaults/\{vault_id\}/credentials
List Credentials
Path parameters
vault_id: string
Query parameters
include_archived: optional booleanWhether to include archived credentials in the results.
limit: optional numberMaximum number of credentials to return per page. Defaults to 20, maximum 100.
format: int32
page: optional stringOpaque pagination token from a previous
list_credentialsresponse.
Headers
"anthropic-beta": optional array of AnthropicBetaOptional 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 42 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"
"anthropic-workspace-id": optional string
Returns
data: optional array of BetaManagedAgentsCredentialList of credentials.
type: "vault_credential"id: stringUnique identifier for the credential.
archived_at: string or nullA timestamp in RFC 3339 format
format: date-time
auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse or BetaManagedAgentsEnvironmentVariableAuthResponseAuthentication details for a credential.
BetaManagedAgentsMCPOAuthAuthResponse objectOAuth credential details for an MCP server.
type: "mcp_oauth"mcp_server_url: stringURL of the MCP server this credential authenticates against.
expires_at: optional string or nullA timestamp in RFC 3339 format
format: date-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse or nullOAuth refresh token configuration returned in credential responses.
client_id: stringOAuth client ID.
token_endpoint: stringToken endpoint URL used to refresh the access token.
token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponseToken endpoint requires no client authentication.
BetaManagedAgentsTokenEndpointAuthNoneResponse objectToken endpoint requires no client authentication.
type: "none"
BetaManagedAgentsTokenEndpointAuthBasicResponse objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"
BetaManagedAgentsTokenEndpointAuthPostResponse objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"
resource: optional string or nullOAuth resource indicator.
scope: optional string or nullOAuth scope for the refresh request.
BetaManagedAgentsStaticBearerAuthResponse objectStatic bearer token credential details for an MCP server.
type: "static_bearer"mcp_server_url: stringURL of the MCP server this credential authenticates against.
BetaManagedAgentsEnvironmentVariableAuthResponse objectEnvironment variable credential details. The secret value is never returned.
type: "environment_variable"injection_location: BetaManagedAgentsInjectionLocationResponseWhere in the outbound request the secret value is substituted.
body: booleanWhether the placeholder is substituted in the request body.
header: booleanWhether the placeholder is substituted in request header values.
networking: BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponseOutbound hosts the secret value is substituted on.
BetaManagedAgentsUnrestrictedCredentialNetworkingResponse objectThe secret is substituted on any host the session's Environment network policy permits egress to.
type: "unrestricted"
BetaManagedAgentsLimitedCredentialNetworkingResponse objectThe secret is substituted only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames on which the secret will be substituted. An entry matches the request host exactly; a
*.-prefixed entry matches any subdomain of the named domain but not the domain itself.
secret_name: stringName of the environment variable.
created_at: stringA timestamp in RFC 3339 format
format: date-time
metadata: map[string]Arbitrary key-value metadata attached to the credential.
updated_at: stringA timestamp in RFC 3339 format
format: date-time
vault_id: stringIdentifier of the vault this credential belongs to.
display_name: optional string or nullHuman-readable name for the credential.
next_page: optional string or nullPagination token for the next page, or null if no more results.
Example
curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"Response (200)
{
"data": [
{
"id": "vcrd_011CZkZEMt8gZan2iYOQfSkw",
"archived_at": null,
"auth": {
"mcp_server_url": "https://example-server.modelcontextprotocol.io/sse",
"type": "static_bearer"
},
"created_at": "2026-03-15T10:00:00Z",
"metadata": {
"environment": "production"
},
"type": "vault_credential",
"updated_at": "2026-03-15T10:00:00Z",
"vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv",
"display_name": "Example credential"
}
],
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}Get Credential
GET /v1/vaults/\{vault_id\}/credentials/\{credential_id\}
Get Credential
Path parameters
vault_id: stringcredential_id: string
Headers
"anthropic-beta": optional array of AnthropicBetaOptional 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 42 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"
"anthropic-workspace-id": optional string
Returns
BetaManagedAgentsCredential objectA credential stored in a vault. Sensitive fields are never returned in responses.
type: "vault_credential"id: stringUnique identifier for the credential.
archived_at: string or nullA timestamp in RFC 3339 format
format: date-time
auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse or BetaManagedAgentsEnvironmentVariableAuthResponseAuthentication details for a credential.
BetaManagedAgentsMCPOAuthAuthResponse objectOAuth credential details for an MCP server.
type: "mcp_oauth"mcp_server_url: stringURL of the MCP server this credential authenticates against.
expires_at: optional string or nullA timestamp in RFC 3339 format
format: date-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse or nullOAuth refresh token configuration returned in credential responses.
client_id: stringOAuth client ID.
token_endpoint: stringToken endpoint URL used to refresh the access token.
token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponseToken endpoint requires no client authentication.
BetaManagedAgentsTokenEndpointAuthNoneResponse objectToken endpoint requires no client authentication.
type: "none"
BetaManagedAgentsTokenEndpointAuthBasicResponse objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"
BetaManagedAgentsTokenEndpointAuthPostResponse objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"
resource: optional string or nullOAuth resource indicator.
scope: optional string or nullOAuth scope for the refresh request.
BetaManagedAgentsStaticBearerAuthResponse objectStatic bearer token credential details for an MCP server.
type: "static_bearer"mcp_server_url: stringURL of the MCP server this credential authenticates against.
BetaManagedAgentsEnvironmentVariableAuthResponse objectEnvironment variable credential details. The secret value is never returned.
type: "environment_variable"injection_location: BetaManagedAgentsInjectionLocationResponseWhere in the outbound request the secret value is substituted.
body: booleanWhether the placeholder is substituted in the request body.
header: booleanWhether the placeholder is substituted in request header values.
networking: BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponseOutbound hosts the secret value is substituted on.
BetaManagedAgentsUnrestrictedCredentialNetworkingResponse objectThe secret is substituted on any host the session's Environment network policy permits egress to.
type: "unrestricted"
BetaManagedAgentsLimitedCredentialNetworkingResponse objectThe secret is substituted only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames on which the secret will be substituted. An entry matches the request host exactly; a
*.-prefixed entry matches any subdomain of the named domain but not the domain itself.
secret_name: stringName of the environment variable.
created_at: stringA timestamp in RFC 3339 format
format: date-time
metadata: map[string]Arbitrary key-value metadata attached to the credential.
updated_at: stringA timestamp in RFC 3339 format
format: date-time
vault_id: stringIdentifier of the vault this credential belongs to.
display_name: optional string or nullHuman-readable name for the credential.
Example
curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials/$CREDENTIAL_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"Response (200)
{
"id": "vcrd_011CZkZEMt8gZan2iYOQfSkw",
"archived_at": null,
"auth": {
"mcp_server_url": "https://example-server.modelcontextprotocol.io/sse",
"type": "static_bearer"
},
"created_at": "2026-03-15T10:00:00Z",
"metadata": {
"environment": "production"
},
"type": "vault_credential",
"updated_at": "2026-03-15T10:00:00Z",
"vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv",
"display_name": "Example credential"
}Update Credential
POST /v1/vaults/\{vault_id\}/credentials/\{credential_id\}
Update Credential
Path parameters
vault_id: stringcredential_id: string
Headers
"anthropic-beta": optional array of AnthropicBetaOptional 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 42 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"
"anthropic-workspace-id": optional string
Body parameters
auth: optional BetaManagedAgentsMCPOAuthUpdateParams or BetaManagedAgentsStaticBearerUpdateParams or BetaManagedAgentsEnvironmentVariableUpdateParamsUpdated authentication details for a credential.
BetaManagedAgentsMCPOAuthUpdateParams objectParameters for updating an MCP OAuth credential. The
mcp_server_urlis immutable.type: "mcp_oauth"access_token: optional string or nullUpdated OAuth access token.
minLength: 1, maxLength: 8192
expires_at: optional string or nullA timestamp in RFC 3339 format
format: date-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshUpdateParams or nullParameters for updating OAuth refresh token configuration.
refresh_token: optional string or nullUpdated OAuth refresh token.
minLength: 1, maxLength: 8192
scope: optional string or nullUpdated OAuth scope for the refresh request.
maxLength: 8192
token_endpoint_auth: optional BetaManagedAgentsTokenEndpointAuthBasicUpdateParam or BetaManagedAgentsTokenEndpointAuthPostUpdateParamUpdated HTTP Basic authentication parameters for the token endpoint.
BetaManagedAgentsTokenEndpointAuthBasicUpdateParam objectUpdated HTTP Basic authentication parameters for the token endpoint.
type: "client_secret_basic"client_secret: optional string or nullUpdated OAuth client secret.
minLength: 1, maxLength: 512
BetaManagedAgentsTokenEndpointAuthPostUpdateParam objectUpdated POST body authentication parameters for the token endpoint.
type: "client_secret_post"client_secret: optional string or nullUpdated OAuth client secret.
minLength: 1, maxLength: 512
BetaManagedAgentsStaticBearerUpdateParams objectParameters for updating a static bearer token credential. The
mcp_server_urlis immutable.type: "static_bearer"token: optional string or nullUpdated static bearer token value.
minLength: 1, maxLength: 8192
BetaManagedAgentsEnvironmentVariableUpdateParams objectParameters for updating an environment variable credential.
secret_nameis immutable.type: "environment_variable"injection_location: optional BetaManagedAgentsInjectionLocationUpdateParamsUpdated injection location.
body: optional booleanSubstitute when the placeholder appears in the request body.
header: optional booleanSubstitute when the placeholder appears in a request header value.
networking: optional BetaManagedAgentsCredentialNetworkingParams or nullUpdated networking scope. Full replacement.
BetaManagedAgentsUnrestrictedCredentialNetworkingParams objectSubstitute the secret on any host the session's Environment network policy permits egress to. The Environment's network policy is the only boundary on where the secret can reach.
type: "unrestricted"
BetaManagedAgentsLimitedCredentialNetworkingParams objectSubstitute the secret only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames on which the secret will be substituted. Each entry is a bare hostname (
api.example.com), an IPv4 address (192.0.2.1), or a*.-prefixed wildcard (*.example.com). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.
secret_value: optional string or nullUpdated secret value.
minLength: 1, maxLength: 4096
display_name: optional string or nullUpdated human-readable name for the credential. 1-255 characters.
minLength: 1, maxLength: 255
metadata: optional map[string] or nullMetadata patch. Set a key to a string to upsert it, or to null to delete it. Omitted keys are preserved.
Returns
BetaManagedAgentsCredential objectA credential stored in a vault. Sensitive fields are never returned in responses.
type: "vault_credential"id: stringUnique identifier for the credential.
archived_at: string or nullA timestamp in RFC 3339 format
format: date-time
auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse or BetaManagedAgentsEnvironmentVariableAuthResponseAuthentication details for a credential.
BetaManagedAgentsMCPOAuthAuthResponse objectOAuth credential details for an MCP server.
type: "mcp_oauth"mcp_server_url: stringURL of the MCP server this credential authenticates against.
expires_at: optional string or nullA timestamp in RFC 3339 format
format: date-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse or nullOAuth refresh token configuration returned in credential responses.
client_id: stringOAuth client ID.
token_endpoint: stringToken endpoint URL used to refresh the access token.
token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponseToken endpoint requires no client authentication.
BetaManagedAgentsTokenEndpointAuthNoneResponse objectToken endpoint requires no client authentication.
type: "none"
BetaManagedAgentsTokenEndpointAuthBasicResponse objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"
BetaManagedAgentsTokenEndpointAuthPostResponse objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"
resource: optional string or nullOAuth resource indicator.
scope: optional string or nullOAuth scope for the refresh request.
BetaManagedAgentsStaticBearerAuthResponse objectStatic bearer token credential details for an MCP server.
type: "static_bearer"mcp_server_url: stringURL of the MCP server this credential authenticates against.
BetaManagedAgentsEnvironmentVariableAuthResponse objectEnvironment variable credential details. The secret value is never returned.
type: "environment_variable"injection_location: BetaManagedAgentsInjectionLocationResponseWhere in the outbound request the secret value is substituted.
body: booleanWhether the placeholder is substituted in the request body.
header: booleanWhether the placeholder is substituted in request header values.
networking: BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponseOutbound hosts the secret value is substituted on.
BetaManagedAgentsUnrestrictedCredentialNetworkingResponse objectThe secret is substituted on any host the session's Environment network policy permits egress to.
type: "unrestricted"
BetaManagedAgentsLimitedCredentialNetworkingResponse objectThe secret is substituted only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames on which the secret will be substituted. An entry matches the request host exactly; a
*.-prefixed entry matches any subdomain of the named domain but not the domain itself.
secret_name: stringName of the environment variable.
created_at: stringA timestamp in RFC 3339 format
format: date-time
metadata: map[string]Arbitrary key-value metadata attached to the credential.
updated_at: stringA timestamp in RFC 3339 format
format: date-time
vault_id: stringIdentifier of the vault this credential belongs to.
display_name: optional string or nullHuman-readable name for the credential.
Example
curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials/$CREDENTIAL_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"display_name": "Example credential",
"metadata": {
"environment": "production"
}
}'Response (200)
{
"id": "vcrd_011CZkZEMt8gZan2iYOQfSkw",
"archived_at": null,
"auth": {
"mcp_server_url": "https://example-server.modelcontextprotocol.io/sse",
"type": "static_bearer"
},
"created_at": "2026-03-15T10:00:00Z",
"metadata": {
"environment": "production"
},
"type": "vault_credential",
"updated_at": "2026-03-15T10:00:00Z",
"vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv",
"display_name": "Example credential"
}Delete Credential
DELETE /v1/vaults/\{vault_id\}/credentials/\{credential_id\}
Delete Credential
Path parameters
vault_id: stringcredential_id: string
Headers
"anthropic-beta": optional array of AnthropicBetaOptional 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 42 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"
"anthropic-workspace-id": optional string
Returns
BetaManagedAgentsDeletedCredential objectConfirmation of a deleted credential.
type: "vault_credential_deleted"id: stringUnique identifier of the deleted credential.
Example
curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials/$CREDENTIAL_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"Response (200)
{
"id": "vcrd_011CZkZEMt8gZan2iYOQfSkw",
"type": "vault_credential_deleted"
}Archive Credential
POST /v1/vaults/\{vault_id\}/credentials/\{credential_id\}/archive
Archive Credential
Path parameters
vault_id: stringcredential_id: string
Headers
"anthropic-beta": optional array of AnthropicBetaOptional 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 42 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"
"anthropic-workspace-id": optional string
Returns
BetaManagedAgentsCredential objectA credential stored in a vault. Sensitive fields are never returned in responses.
type: "vault_credential"id: stringUnique identifier for the credential.
archived_at: string or nullA timestamp in RFC 3339 format
format: date-time
auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse or BetaManagedAgentsEnvironmentVariableAuthResponseAuthentication details for a credential.
BetaManagedAgentsMCPOAuthAuthResponse objectOAuth credential details for an MCP server.
type: "mcp_oauth"mcp_server_url: stringURL of the MCP server this credential authenticates against.
expires_at: optional string or nullA timestamp in RFC 3339 format
format: date-time
refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse or nullOAuth refresh token configuration returned in credential responses.
client_id: stringOAuth client ID.
token_endpoint: stringToken endpoint URL used to refresh the access token.
token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponseToken endpoint requires no client authentication.
BetaManagedAgentsTokenEndpointAuthNoneResponse objectToken endpoint requires no client authentication.
type: "none"
BetaManagedAgentsTokenEndpointAuthBasicResponse objectToken endpoint uses HTTP Basic authentication with client credentials.
type: "client_secret_basic"
BetaManagedAgentsTokenEndpointAuthPostResponse objectToken endpoint uses POST body authentication with client credentials.
type: "client_secret_post"
resource: optional string or nullOAuth resource indicator.
scope: optional string or nullOAuth scope for the refresh request.
BetaManagedAgentsStaticBearerAuthResponse objectStatic bearer token credential details for an MCP server.
type: "static_bearer"mcp_server_url: stringURL of the MCP server this credential authenticates against.
BetaManagedAgentsEnvironmentVariableAuthResponse objectEnvironment variable credential details. The secret value is never returned.
type: "environment_variable"injection_location: BetaManagedAgentsInjectionLocationResponseWhere in the outbound request the secret value is substituted.
body: booleanWhether the placeholder is substituted in the request body.
header: booleanWhether the placeholder is substituted in request header values.
networking: BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponseOutbound hosts the secret value is substituted on.
BetaManagedAgentsUnrestrictedCredentialNetworkingResponse objectThe secret is substituted on any host the session's Environment network policy permits egress to.
type: "unrestricted"
BetaManagedAgentsLimitedCredentialNetworkingResponse objectThe secret is substituted only on requests to the listed hosts.
type: "limited"allowed_hosts: array of stringHostnames on which the secret will be substituted. An entry matches the request host exactly; a
*.-prefixed entry matches any subdomain of the named domain but not the domain itself.
secret_name: stringName of the environment variable.
created_at: stringA timestamp in RFC 3339 format
format: date-time
metadata: map[string]Arbitrary key-value metadata attached to the credential.
updated_at: stringA timestamp in RFC 3339 format
format: date-time
vault_id: stringIdentifier of the vault this credential belongs to.
display_name: optional string or nullHuman-readable name for the credential.
Example
curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials/$CREDENTIAL_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"Response (200)
{
"id": "vcrd_011CZkZEMt8gZan2iYOQfSkw",
"archived_at": null,
"auth": {
"mcp_server_url": "https://example-server.modelcontextprotocol.io/sse",
"type": "static_bearer"
},
"created_at": "2026-03-15T10:00:00Z",
"metadata": {
"environment": "production"
},
"type": "vault_credential",
"updated_at": "2026-03-15T10:00:00Z",
"vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv",
"display_name": "Example credential"
}Validate Credential
POST /v1/vaults/\{vault_id\}/credentials/\{credential_id\}/mcp_oauth_validate
Validate Credential
Path parameters
vault_id: stringcredential_id: string
Headers
"anthropic-beta": optional array of AnthropicBetaOptional 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 42 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"
"anthropic-workspace-id": optional string
Returns
BetaManagedAgentsCredentialValidation objectResult of live-probing a credential against its configured MCP server.
type: "vault_credential_validation"credential_id: stringUnique identifier of the credential that was validated.
has_refresh_token: booleanWhether the credential has a refresh token configured.
mcp_probe: BetaManagedAgentsMCPProbe or nullThe failing step of an MCP validation probe.
http_response: BetaManagedAgentsRefreshHTTPResponse or nullAn HTTP response captured during a credential validation probe.
body: stringResponse body. May be truncated and has sensitive values scrubbed.
body_truncated: booleanWhether
bodywas truncated.content_type: stringValue of the
Content-Typeresponse header.status_code: numberHTTP status code.
format: int32
method: stringThe MCP method that failed (for example
initializeortools/list).
refresh: BetaManagedAgentsRefreshObject or nullOutcome of a refresh-token exchange attempted during credential validation.
http_response: BetaManagedAgentsRefreshHTTPResponse or nullAn HTTP response captured during a credential validation probe.
status: "succeeded" or "failed" or "connect_error" or "no_refresh_token"Outcome of a refresh-token exchange attempted during credential validation.
"succeeded""failed""connect_error""no_refresh_token"
status: BetaManagedAgentsCredentialValidationStatusOverall verdict of a credential validation probe.
"valid""invalid""unknown"
validated_at: stringA timestamp in RFC 3339 format
format: date-time
vault_id: stringIdentifier of the vault containing the credential.
Example
curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials/$CREDENTIAL_ID/mcp_oauth_validate \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"Response (200)
{
"credential_id": "vcrd_011CZkZEMt8gZan2iYOQfSkw",
"has_refresh_token": true,
"mcp_probe": {
"http_response": {
"body": "body",
"body_truncated": true,
"content_type": "content_type",
"status_code": 0
},
"method": "method"
},
"refresh": {
"http_response": {
"body": "body",
"body_truncated": true,
"content_type": "content_type",
"status_code": 0
},
"status": "succeeded"
},
"status": "valid",
"type": "vault_credential_validation",
"validated_at": "2026-03-15T10:00:00Z",
"vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv"
}