One read of Claude Developer Platformapi-20260814T043121Z
565 pages moved out of 565 read.
What this read moved
301-325 of 565, page 13 of 23This capture is too large to show at once. Changes 301-325 of 565 are below, significant first; the rest are on the following screens.
api/beta/skills/versions/delete First recorded · 133 lines, first recorded
## Delete Skill Version ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Delete Skill Version
url: https://platform.claude.com/docs/en/api/beta/skills/versions/delete
---
## Delete Skill Version
**delete** `/v1/skills/{skill_id}/versions/{version}`
Delete Skill Version
### Path Parameters
- `skill_id: string`
Unique identifier for the skill.
The format and length of IDs may change over time.
- `version: string`
Version identifier for the skill.
Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129").
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `id: string`
Version identifier for the skill.
Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129").
- `type: string`
Deleted object type.
For Skill Versions, this is always `"skill_version_deleted"`.
### Example
```http
curl https://api.anthropic.com/v1/skills/$SKILL_ID/versions/$VERSION \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: skills-2025-10-02' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "1759178010641129",
"type": "type"
}
```
api/beta/skills/versions/download First recorded · 109 lines, first recorded
## Download Skill Version Content ### Path Parameters ### Header Parameters ### Example
The first capture of this source. The page was already there, and this is what it said.
---
title: Download Skill Version Content
url: https://platform.claude.com/docs/en/api/beta/skills/versions/download
---
## Download Skill Version Content
**get** `/v1/skills/{skill_id}/versions/{version}/content`
Download a skill version's content as a zip archive.
### Path Parameters
- `skill_id: string`
Unique identifier for the skill.
The format and length of IDs may change over time.
- `version: string`
Version identifier for the skill.
Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129").
### Header Parameters
- `"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 30 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"`
- `"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"`
### Example
```http
curl https://api.anthropic.com/v1/skills/$SKILL_ID/versions/$VERSION/content \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: skills-2025-10-02' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
api/beta/skills/versions/list First recorded · 194 lines, first recorded
## List Skill Versions ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List Skill Versions
url: https://platform.claude.com/docs/en/api/beta/skills/versions/list
---
## List Skill Versions
**get** `/v1/skills/{skill_id}/versions`
List Skill Versions
### Path Parameters
- `skill_id: string`
Unique identifier for the skill.
The format and length of IDs may change over time.
### Query Parameters
- `limit: optional number`
Number of items to return per page.
Defaults to `20`. Ranges from `1` to `1000`.
- `page: optional string`
Optionally set to the `next_page` token from the previous response.
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `data: array of object { id, created_at, description, 5 more }`
List of skill versions.
- `id: string`
Unique identifier for the skill version.
The format and length of IDs may change over time.
- `created_at: string`
ISO 8601 timestamp of when the skill version was created.
- `description: string`
Description of the skill version.
This is extracted from the SKILL.md file in the skill upload.
- `directory: string`
Directory name of the skill version.
This is the top-level directory name that was extracted from the uploaded files.
- `name: string`
Human-readable name of the skill version.
This is extracted from the SKILL.md file in the skill upload.
- `skill_id: string`
Identifier for the skill that this version belongs to.
- `type: string`
Object type.
For Skill Versions, this is always `"skill_version"`.
- `version: string`
Version identifier for the skill.
Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129").
- `has_more: boolean`
Indicates if there are more results in the requested page direction.
- `next_page: string or null`
Token to provide in as `page` in the subsequent request to retrieve the next page of data.
### Example
```http
curl https://api.anthropic.com/v1/skills/$SKILL_ID/versions \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: skills-2025-10-02' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "skillver_01JAbcdefghijklmnopqrstuvw",
"created_at": "2024-10-30T23:58:27.427722Z",
"description": "A custom skill for doing something useful",
"directory": "my-skill",
"name": "my-skill",
"skill_id": "skill_01JAbcdefghijklmnopqrstuvw",
"type": "type",
"version": "1759178010641129"
}
],
"has_more": true,
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
```
api/beta/skills/versions/retrieve First recorded · 170 lines, first recorded
## Get Skill Version ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get Skill Version
url: https://platform.claude.com/docs/en/api/beta/skills/versions/retrieve
---
## Get Skill Version
**get** `/v1/skills/{skill_id}/versions/{version}`
Get Skill Version
### Path Parameters
- `skill_id: string`
Unique identifier for the skill.
The format and length of IDs may change over time.
- `version: string`
Version identifier for the skill.
Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129").
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `id: string`
Unique identifier for the skill version.
The format and length of IDs may change over time.
- `created_at: string`
ISO 8601 timestamp of when the skill version was created.
- `description: string`
Description of the skill version.
This is extracted from the SKILL.md file in the skill upload.
- `directory: string`
Directory name of the skill version.
This is the top-level directory name that was extracted from the uploaded files.
- `name: string`
Human-readable name of the skill version.
This is extracted from the SKILL.md file in the skill upload.
- `skill_id: string`
Identifier for the skill that this version belongs to.
- `type: string`
Object type.
For Skill Versions, this is always `"skill_version"`.
- `version: string`
Version identifier for the skill.
Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129").
### Example
```http
curl https://api.anthropic.com/v1/skills/$SKILL_ID/versions/$VERSION \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: skills-2025-10-02' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "skillver_01JAbcdefghijklmnopqrstuvw",
"created_at": "2024-10-30T23:58:27.427722Z",
"description": "A custom skill for doing something useful",
"directory": "my-skill",
"name": "my-skill",
"skill_id": "skill_01JAbcdefghijklmnopqrstuvw",
"type": "type",
"version": "1759178010641129"
}
```
api/beta/tunnels First recorded · 1555 lines, first recorded
# Tunnels ## Create Tunnel ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Get Tunnel ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## List Tunnels ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Tunnel ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Reveal Tunnel Token ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Rotate Tunnel Token ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Tunnel ### Beta Tunnel Token # Certificates ## Create Tunnel Certificate ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Get Tunnel Certificate ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## List Tunnel Certificates ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Tunnel Certificate ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Tunnel Certificate
The first capture of this source. The page was already there, and this is what it said.
---
title: Tunnels
url: https://platform.claude.com/docs/en/api/beta/tunnels
---
# Tunnels
## Create Tunnel
**post** `/v1/tunnels`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; it is not idempotent. The new tunnel rejects MCP traffic until at least one CA certificate is added.
### Header Parameters
- `"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 30 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"`
- `"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"`
### Body Parameters
- `display_name: optional string or null`
Optional human-readable name for the tunnel (1-255 characters).
### Returns
- `BetaTunnel object { id, archived_at, created_at, 3 more }`
An MCP tunnel.
- `id: string`
Unique identifier for the tunnel, prefixed with `tnl_`.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `display_name: string or null`
Human-readable name for the tunnel (1-255 characters). Null if unset.
- `domain: string`
Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
- `type: "tunnel"`
- `"tunnel"`
### Example
```http
curl https://api.anthropic.com/v1/tunnels \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{}'
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"display_name": "display_name",
"domain": "domain",
"type": "tunnel"
}
```
## Get Tunnel
**get** `/v1/tunnels/{tunnel_id}`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Fetches a tunnel by ID.
### Path Parameters
- `tunnel_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `BetaTunnel object { id, archived_at, created_at, 3 more }`
An MCP tunnel.
- `id: string`
Unique identifier for the tunnel, prefixed with `tnl_`.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `display_name: string or null`
Human-readable name for the tunnel (1-255 characters). Null if unset.
- `domain: string`
Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
- `type: "tunnel"`
- `"tunnel"`
### Example
```http
curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"display_name": "display_name",
"domain": "domain",
"type": "tunnel"
}
```
## List Tunnels
**get** `/v1/tunnels`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Lists tunnels. Results are ordered by creation time, newest first; archived tunnels are excluded unless include_archived is set.
### Query Parameters
Cut at 300 lines. The page has the rest.
api/beta/tunnels/archive First recorded · 145 lines, first recorded
## Archive Tunnel ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Archive Tunnel
url: https://platform.claude.com/docs/en/api/beta/tunnels/archive
---
## Archive Tunnel
**post** `/v1/tunnels/{tunnel_id}/archive`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Archives a tunnel. Archival is irreversible: every non-archived certificate on the tunnel is archived in the same operation, the hostname is retired and never re-allocated, and the tunnel token is invalidated. Retrying against an already-archived tunnel returns the existing record unchanged.
### Path Parameters
- `tunnel_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `BetaTunnel object { id, archived_at, created_at, 3 more }`
An MCP tunnel.
- `id: string`
Unique identifier for the tunnel, prefixed with `tnl_`.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `display_name: string or null`
Human-readable name for the tunnel (1-255 characters). Null if unset.
- `domain: string`
Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
- `type: "tunnel"`
- `"tunnel"`
### Example
```http
curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"display_name": "display_name",
"domain": "domain",
"type": "tunnel"
}
```
api/beta/tunnels/certificates First recorded · 660 lines, first recorded
# Certificates ## Create Tunnel Certificate ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Get Tunnel Certificate ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## List Tunnel Certificates ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Tunnel Certificate ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Tunnel Certificate
The first capture of this source. The page was already there, and this is what it said.
---
title: Certificates
url: https://platform.claude.com/docs/en/api/beta/tunnels/certificates
---
# Certificates
## Create Tunnel Certificate
**post** `/v1/tunnels/{tunnel_id}/certificates`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's server certificate against this CA when it terminates the inner TLS session. A tunnel holds at most two non-archived certificates.
### Path Parameters
- `tunnel_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Body Parameters
- `ca_certificate_pem: string`
PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB.
### Returns
- `BetaTunnelCertificate object { id, archived_at, created_at, 4 more }`
A CA certificate attached to a tunnel.
- `id: string`
Unique identifier for the certificate, prefixed with `tcrt_`.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `expires_at: string or null`
A timestamp in RFC 3339 format
- `fingerprint: string`
Lowercase hex SHA-256 fingerprint of the certificate's DER encoding.
- `tunnel_id: string`
ID of the tunnel the certificate is registered against.
- `type: "tunnel_certificate"`
- `"tunnel_certificate"`
### Example
```http
curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"ca_certificate_pem": "ca_certificate_pem"
}'
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"expires_at": "2019-12-27T18:11:19.117Z",
"fingerprint": "fingerprint",
"tunnel_id": "tunnel_id",
"type": "tunnel_certificate"
}
```
## Get Tunnel Certificate
**get** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Fetches a tunnel certificate by ID.
### Path Parameters
- `tunnel_id: string`
- `certificate_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `BetaTunnelCertificate object { id, archived_at, created_at, 4 more }`
A CA certificate attached to a tunnel.
- `id: string`
Unique identifier for the certificate, prefixed with `tcrt_`.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `expires_at: string or null`
A timestamp in RFC 3339 format
- `fingerprint: string`
Lowercase hex SHA-256 fingerprint of the certificate's DER encoding.
- `tunnel_id: string`
ID of the tunnel the certificate is registered against.
- `type: "tunnel_certificate"`
- `"tunnel_certificate"`
### Example
```http
curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "id",
Cut at 300 lines. The page has the rest.
api/beta/tunnels/certificates/archive First recorded · 152 lines, first recorded
## Archive Tunnel Certificate ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Archive Tunnel Certificate
url: https://platform.claude.com/docs/en/api/beta/tunnels/certificates/archive
---
## Archive Tunnel Certificate
**post** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added.
### Path Parameters
- `tunnel_id: string`
- `certificate_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `BetaTunnelCertificate object { id, archived_at, created_at, 4 more }`
A CA certificate attached to a tunnel.
- `id: string`
Unique identifier for the certificate, prefixed with `tcrt_`.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `expires_at: string or null`
A timestamp in RFC 3339 format
- `fingerprint: string`
Lowercase hex SHA-256 fingerprint of the certificate's DER encoding.
- `tunnel_id: string`
ID of the tunnel the certificate is registered against.
- `type: "tunnel_certificate"`
- `"tunnel_certificate"`
### Example
```http
curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"expires_at": "2019-12-27T18:11:19.117Z",
"fingerprint": "fingerprint",
"tunnel_id": "tunnel_id",
"type": "tunnel_certificate"
}
```
api/beta/tunnels/certificates/create First recorded · 159 lines, first recorded
## Create Tunnel Certificate ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Create Tunnel Certificate
url: https://platform.claude.com/docs/en/api/beta/tunnels/certificates/create
---
## Create Tunnel Certificate
**post** `/v1/tunnels/{tunnel_id}/certificates`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's server certificate against this CA when it terminates the inner TLS session. A tunnel holds at most two non-archived certificates.
### Path Parameters
- `tunnel_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Body Parameters
- `ca_certificate_pem: string`
PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB.
### Returns
- `BetaTunnelCertificate object { id, archived_at, created_at, 4 more }`
A CA certificate attached to a tunnel.
- `id: string`
Unique identifier for the certificate, prefixed with `tcrt_`.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `expires_at: string or null`
A timestamp in RFC 3339 format
- `fingerprint: string`
Lowercase hex SHA-256 fingerprint of the certificate's DER encoding.
- `tunnel_id: string`
ID of the tunnel the certificate is registered against.
- `type: "tunnel_certificate"`
- `"tunnel_certificate"`
### Example
```http
curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"ca_certificate_pem": "ca_certificate_pem"
}'
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"expires_at": "2019-12-27T18:11:19.117Z",
"fingerprint": "fingerprint",
"tunnel_id": "tunnel_id",
"type": "tunnel_certificate"
}
```
api/beta/tunnels/certificates/list First recorded · 172 lines, first recorded
## List Tunnel Certificates ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List Tunnel Certificates
url: https://platform.claude.com/docs/en/api/beta/tunnels/certificates/list
---
## List Tunnel Certificates
**get** `/v1/tunnels/{tunnel_id}/certificates`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set.
### Path Parameters
- `tunnel_id: string`
### Query Parameters
- `include_archived: optional boolean`
Whether to include archived certificates in the results. Defaults to false.
- `limit: optional number`
Maximum number of certificates to return per page. Defaults to 20, maximum 1000.
- `page: optional string`
Opaque pagination cursor from a previous `list_tunnel_certificates` response.
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `data: array of BetaTunnelCertificate`
List of certificates, ordered by created_at descending.
- `id: string`
Unique identifier for the certificate, prefixed with `tcrt_`.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `expires_at: string or null`
A timestamp in RFC 3339 format
- `fingerprint: string`
Lowercase hex SHA-256 fingerprint of the certificate's DER encoding.
- `tunnel_id: string`
ID of the tunnel the certificate is registered against.
- `type: "tunnel_certificate"`
- `"tunnel_certificate"`
- `next_page: string or null`
Pagination cursor for the next page, or null if no more results.
### Example
```http
curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"expires_at": "2019-12-27T18:11:19.117Z",
"fingerprint": "fingerprint",
"tunnel_id": "tunnel_id",
"type": "tunnel_certificate"
}
],
"next_page": "next_page"
}
```
api/beta/tunnels/certificates/retrieve First recorded · 151 lines, first recorded
## Get Tunnel Certificate ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get Tunnel Certificate
url: https://platform.claude.com/docs/en/api/beta/tunnels/certificates/retrieve
---
## Get Tunnel Certificate
**get** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Fetches a tunnel certificate by ID.
### Path Parameters
- `tunnel_id: string`
- `certificate_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `BetaTunnelCertificate object { id, archived_at, created_at, 4 more }`
A CA certificate attached to a tunnel.
- `id: string`
Unique identifier for the certificate, prefixed with `tcrt_`.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `expires_at: string or null`
A timestamp in RFC 3339 format
- `fingerprint: string`
Lowercase hex SHA-256 fingerprint of the certificate's DER encoding.
- `tunnel_id: string`
ID of the tunnel the certificate is registered against.
- `type: "tunnel_certificate"`
- `"tunnel_certificate"`
### Example
```http
curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"expires_at": "2019-12-27T18:11:19.117Z",
"fingerprint": "fingerprint",
"tunnel_id": "tunnel_id",
"type": "tunnel_certificate"
}
```
api/beta/tunnels/create First recorded · 148 lines, first recorded
## Create Tunnel ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Create Tunnel
url: https://platform.claude.com/docs/en/api/beta/tunnels/create
---
## Create Tunnel
**post** `/v1/tunnels`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; it is not idempotent. The new tunnel rejects MCP traffic until at least one CA certificate is added.
### Header Parameters
- `"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 30 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"`
- `"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"`
### Body Parameters
- `display_name: optional string or null`
Optional human-readable name for the tunnel (1-255 characters).
### Returns
- `BetaTunnel object { id, archived_at, created_at, 3 more }`
An MCP tunnel.
- `id: string`
Unique identifier for the tunnel, prefixed with `tnl_`.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `display_name: string or null`
Human-readable name for the tunnel (1-255 characters). Null if unset.
- `domain: string`
Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
- `type: "tunnel"`
- `"tunnel"`
### Example
```http
curl https://api.anthropic.com/v1/tunnels \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{}'
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"display_name": "display_name",
"domain": "domain",
"type": "tunnel"
}
```
api/beta/tunnels/list First recorded · 163 lines, first recorded
## List Tunnels ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List Tunnels
url: https://platform.claude.com/docs/en/api/beta/tunnels/list
---
## List Tunnels
**get** `/v1/tunnels`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Lists tunnels. Results are ordered by creation time, newest first; archived tunnels are excluded unless include_archived is set.
### Query Parameters
- `include_archived: optional boolean`
Whether to include archived tunnels in the results. Defaults to false.
- `limit: optional number`
Maximum number of tunnels to return per page. Defaults to 20, maximum 1000.
- `page: optional string`
Opaque pagination cursor from a previous `list_tunnels` response.
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `data: array of BetaTunnel`
List of tunnels, ordered by created_at descending.
- `id: string`
Unique identifier for the tunnel, prefixed with `tnl_`.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `display_name: string or null`
Human-readable name for the tunnel (1-255 characters). Null if unset.
- `domain: string`
Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
- `type: "tunnel"`
- `"tunnel"`
- `next_page: string or null`
Pagination cursor for the next page, or null if no more results.
### Example
```http
curl https://api.anthropic.com/v1/tunnels \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"display_name": "display_name",
"domain": "domain",
"type": "tunnel"
}
],
"next_page": "next_page"
}
```
api/beta/tunnels/retrieve First recorded · 144 lines, first recorded
## Get Tunnel ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get Tunnel
url: https://platform.claude.com/docs/en/api/beta/tunnels/retrieve
---
## Get Tunnel
**get** `/v1/tunnels/{tunnel_id}`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Fetches a tunnel by ID.
### Path Parameters
- `tunnel_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `BetaTunnel object { id, archived_at, created_at, 3 more }`
An MCP tunnel.
- `id: string`
Unique identifier for the tunnel, prefixed with `tnl_`.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `display_name: string or null`
Human-readable name for the tunnel (1-255 characters). Null if unset.
- `domain: string`
Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
- `type: "tunnel"`
- `"tunnel"`
### Example
```http
curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"display_name": "display_name",
"domain": "domain",
"type": "tunnel"
}
```
api/beta/tunnels/reveal_token First recorded · 130 lines, first recorded
## Reveal Tunnel Token ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Reveal Tunnel Token
url: https://platform.claude.com/docs/en/api/beta/tunnels/reveal_token
---
## Reveal Tunnel Token
**post** `/v1/tunnels/{tunnel_id}/reveal_token`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Reveals a tunnel's connector token. The value is fetched live on each call; Anthropic does not store it. Repeated calls return the same value until the token is rotated. Exposed as POST so the token does not appear in intermediary access logs.
### Path Parameters
- `tunnel_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `BetaTunnelToken object { id, tunnel_token, type }`
A tunnel's connector token.
- `id: string`
Stable identifier for the current token value. Changes when the token is rotated.
- `tunnel_token: string`
The connector token used to run the tunnel. Treat as a credential.
- `type: "tunnel_token"`
- `"tunnel_token"`
### Example
```http
curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/reveal_token \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "id",
"tunnel_token": "tunnel_token",
"type": "tunnel_token"
}
```
api/beta/tunnels/rotate_token First recorded · 137 lines, first recorded
## Rotate Tunnel Token ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Rotate Tunnel Token
url: https://platform.claude.com/docs/en/api/beta/tunnels/rotate_token
---
## Rotate Tunnel Token
**post** `/v1/tunnels/{tunnel_id}/rotate_token`
The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window.
Rotates a tunnel's connector token. Rotation invalidates the current token for new connections and returns a fresh value; established connections are not severed. A connector restarted after rotation must use the new value.
### Path Parameters
- `tunnel_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Body Parameters
- `reason: optional string or null`
Optional free-text reason for the rotation, recorded for audit.
### Returns
- `BetaTunnelToken object { id, tunnel_token, type }`
A tunnel's connector token.
- `id: string`
Stable identifier for the current token value. Changes when the token is rotated.
- `tunnel_token: string`
The connector token used to run the tunnel. Treat as a credential.
- `type: "tunnel_token"`
- `"tunnel_token"`
### Example
```http
curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/rotate_token \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: mcp-tunnels-2026-06-22' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{}'
```
#### Response
```json
{
"id": "id",
"tunnel_token": "tunnel_token",
"type": "tunnel_token"
}
```
api/beta/user_profiles First recorded · 992 lines, first recorded
# User Profiles ## Create User Profile ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List User Profiles ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get User Profile ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update User Profile ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Create Enrollment URL ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta User Profile ### Beta User Profile Enrollment URL ### Beta User Profile Trust Grant
The first capture of this source. The page was already there, and this is what it said.
---
title: User Profiles
url: https://platform.claude.com/docs/en/api/beta/user_profiles
---
# User Profiles
## Create User Profile
**post** `/v1/user_profiles`
Create User Profile
### Header Parameters
- `"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 30 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"`
- `"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"`
### Body Parameters
- `external_id: optional string or null`
Platform's own identifier for this user. Not enforced unique. Maximum 255 characters.
- `metadata: optional map[string]`
Free-form key-value data to attach to this user profile. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. Values must be non-empty strings.
- `name: optional string or null`
Display name of the entity this profile represents. Required when relationship is `resold` (the resold-to company's name); optional otherwise. Maximum 255 characters.
- `relationship: optional "external" or "resold" or "internal"`
How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
- `"external"`
- `"resold"`
- `"internal"`
### Returns
- `BetaUserProfile object { id, created_at, metadata, 6 more }`
- `id: string`
Unique identifier for this user profile, prefixed `uprof_`.
- `created_at: string`
A timestamp in RFC 3339 format
- `metadata: map[string]`
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
- `relationship: "external" or "resold" or "internal"`
How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
- `"external"`
- `"resold"`
- `"internal"`
- `trust_grants: map[BetaUserProfileTrustGrant]`
Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
- `status: "active" or "pending" or "rejected"`
Status of the trust grant.
- `"active"`
- `"pending"`
- `"rejected"`
- `type: "user_profile"`
Object type. Always `user_profile`.
- `"user_profile"`
- `updated_at: string`
A timestamp in RFC 3339 format
- `external_id: optional string or null`
Platform's own identifier for this user. Not enforced unique.
- `name: optional string or null`
Display name of the entity this profile represents. For `resold` this is the resold-to company's name.
### Example
```http
curl https://api.anthropic.com/v1/user_profiles \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: user-profiles-2026-03-24' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"external_id": "user_12345",
"metadata": {}
}'
```
#### Response
```json
{
"id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
"created_at": "2026-03-15T10:00:00Z",
"metadata": {},
"relationship": "external",
"trust_grants": {
"cyber": {
"status": "active"
}
},
"type": "user_profile",
"updated_at": "2026-03-15T10:00:00Z",
"external_id": "user_12345",
"name": "Example User"
}
```
## List User Profiles
**get** `/v1/user_profiles`
List User Profiles
### Query Parameters
- `limit: optional number`
Query parameter for limit
- `order: optional "asc" or "desc"`
Query parameter for order
- `"asc"`
- `"desc"`
- `page: optional string`
Query parameter for page
### Header Parameters
- `"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 30 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"`
- `"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"`
Cut at 300 lines. The page has the rest.
api/beta/user_profiles/create First recorded · 202 lines, first recorded
## Create User Profile ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Create User Profile
url: https://platform.claude.com/docs/en/api/beta/user_profiles/create
---
## Create User Profile
**post** `/v1/user_profiles`
Create User Profile
### Header Parameters
- `"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 30 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"`
- `"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"`
### Body Parameters
- `external_id: optional string or null`
Platform's own identifier for this user. Not enforced unique. Maximum 255 characters.
- `metadata: optional map[string]`
Free-form key-value data to attach to this user profile. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. Values must be non-empty strings.
- `name: optional string or null`
Display name of the entity this profile represents. Required when relationship is `resold` (the resold-to company's name); optional otherwise. Maximum 255 characters.
- `relationship: optional "external" or "resold" or "internal"`
How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
- `"external"`
- `"resold"`
- `"internal"`
### Returns
- `BetaUserProfile object { id, created_at, metadata, 6 more }`
- `id: string`
Unique identifier for this user profile, prefixed `uprof_`.
- `created_at: string`
A timestamp in RFC 3339 format
- `metadata: map[string]`
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
- `relationship: "external" or "resold" or "internal"`
How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
- `"external"`
- `"resold"`
- `"internal"`
- `trust_grants: map[BetaUserProfileTrustGrant]`
Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
- `status: "active" or "pending" or "rejected"`
Status of the trust grant.
- `"active"`
- `"pending"`
- `"rejected"`
- `type: "user_profile"`
Object type. Always `user_profile`.
- `"user_profile"`
- `updated_at: string`
A timestamp in RFC 3339 format
- `external_id: optional string or null`
Platform's own identifier for this user. Not enforced unique.
- `name: optional string or null`
Display name of the entity this profile represents. For `resold` this is the resold-to company's name.
### Example
```http
curl https://api.anthropic.com/v1/user_profiles \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: user-profiles-2026-03-24' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"external_id": "user_12345",
"metadata": {}
}'
```
#### Response
```json
{
"id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
"created_at": "2026-03-15T10:00:00Z",
"metadata": {},
"relationship": "external",
"trust_grants": {
"cyber": {
"status": "active"
}
},
"type": "user_profile",
"updated_at": "2026-03-15T10:00:00Z",
"external_id": "user_12345",
"name": "Example User"
}
```
api/beta/user_profiles/create_enrollment_url First recorded · 128 lines, first recorded
## Create Enrollment URL ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Create Enrollment URL
url: https://platform.claude.com/docs/en/api/beta/user_profiles/create_enrollment_url
---
## Create Enrollment URL
**post** `/v1/user_profiles/{user_profile_id}/enrollment_url`
Create Enrollment URL
### Path Parameters
- `user_profile_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `BetaUserProfileEnrollmentURL object { expires_at, type, url }`
- `expires_at: string`
A timestamp in RFC 3339 format
- `type: "enrollment_url"`
Object type. Always `enrollment_url`.
- `"enrollment_url"`
- `url: string`
Enrollment URL to send to the end user. Valid until `expires_at`.
### Example
```http
curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID/enrollment_url \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: user-profiles-2026-03-24' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"expires_at": "2026-03-15T10:15:00Z",
"type": "enrollment_url",
"url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1"
}
```
api/beta/user_profiles/list First recorded · 202 lines, first recorded
## List User Profiles ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List User Profiles
url: https://platform.claude.com/docs/en/api/beta/user_profiles/list
---
## List User Profiles
**get** `/v1/user_profiles`
List User Profiles
### Query Parameters
- `limit: optional number`
Query parameter for limit
- `order: optional "asc" or "desc"`
Query parameter for order
- `"asc"`
- `"desc"`
- `page: optional string`
Query parameter for page
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `data: array of BetaUserProfile`
User profiles on this page.
- `id: string`
Unique identifier for this user profile, prefixed `uprof_`.
- `created_at: string`
A timestamp in RFC 3339 format
- `metadata: map[string]`
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
- `relationship: "external" or "resold" or "internal"`
How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
- `"external"`
- `"resold"`
- `"internal"`
- `trust_grants: map[BetaUserProfileTrustGrant]`
Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
- `status: "active" or "pending" or "rejected"`
Status of the trust grant.
- `"active"`
- `"pending"`
- `"rejected"`
- `type: "user_profile"`
Object type. Always `user_profile`.
- `"user_profile"`
- `updated_at: string`
A timestamp in RFC 3339 format
- `external_id: optional string or null`
Platform's own identifier for this user. Not enforced unique.
- `name: optional string or null`
Display name of the entity this profile represents. For `resold` this is the resold-to company's name.
- `next_page: string or null`
Cursor for the next page, or `null` when there are no more results.
### Example
```http
curl https://api.anthropic.com/v1/user_profiles \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: user-profiles-2026-03-24' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
"created_at": "2026-03-15T10:00:00Z",
"metadata": {},
"relationship": "external",
"trust_grants": {
"cyber": {
"status": "active"
}
},
"type": "user_profile",
"updated_at": "2026-03-15T10:00:00Z",
"external_id": "user_12345",
"name": "Example User"
}
],
"next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}
```
api/beta/user_profiles/retrieve First recorded · 177 lines, first recorded
## Get User Profile ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get User Profile
url: https://platform.claude.com/docs/en/api/beta/user_profiles/retrieve
---
## Get User Profile
**get** `/v1/user_profiles/{user_profile_id}`
Get User Profile
### Path Parameters
- `user_profile_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `BetaUserProfile object { id, created_at, metadata, 6 more }`
- `id: string`
Unique identifier for this user profile, prefixed `uprof_`.
- `created_at: string`
A timestamp in RFC 3339 format
- `metadata: map[string]`
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
- `relationship: "external" or "resold" or "internal"`
How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
- `"external"`
- `"resold"`
- `"internal"`
- `trust_grants: map[BetaUserProfileTrustGrant]`
Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
- `status: "active" or "pending" or "rejected"`
Status of the trust grant.
- `"active"`
- `"pending"`
- `"rejected"`
- `type: "user_profile"`
Object type. Always `user_profile`.
- `"user_profile"`
- `updated_at: string`
A timestamp in RFC 3339 format
- `external_id: optional string or null`
Platform's own identifier for this user. Not enforced unique.
- `name: optional string or null`
Display name of the entity this profile represents. For `resold` this is the resold-to company's name.
### Example
```http
curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: user-profiles-2026-03-24' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
"created_at": "2026-03-15T10:00:00Z",
"metadata": {},
"relationship": "external",
"trust_grants": {
"cyber": {
"status": "active"
}
},
"type": "user_profile",
"updated_at": "2026-03-15T10:00:00Z",
"external_id": "user_12345",
"name": "Example User"
}
```
api/beta/user_profiles/update First recorded · 205 lines, first recorded
## Update User Profile ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Update User Profile
url: https://platform.claude.com/docs/en/api/beta/user_profiles/update
---
## Update User Profile
**post** `/v1/user_profiles/{user_profile_id}`
Update User Profile
### Path Parameters
- `user_profile_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Body Parameters
- `external_id: optional string or null`
If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters.
- `metadata: optional map[string]`
Key-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters.
- `name: optional string or null`
If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters.
- `relationship: optional "external" or "resold" or "internal" or null`
How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
- `"external"`
- `"resold"`
- `"internal"`
### Returns
- `BetaUserProfile object { id, created_at, metadata, 6 more }`
- `id: string`
Unique identifier for this user profile, prefixed `uprof_`.
- `created_at: string`
A timestamp in RFC 3339 format
- `metadata: map[string]`
Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
- `relationship: "external" or "resold" or "internal"`
How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage.
- `"external"`
- `"resold"`
- `"internal"`
- `trust_grants: map[BetaUserProfileTrustGrant]`
Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.
- `status: "active" or "pending" or "rejected"`
Status of the trust grant.
- `"active"`
- `"pending"`
- `"rejected"`
- `type: "user_profile"`
Object type. Always `user_profile`.
- `"user_profile"`
- `updated_at: string`
A timestamp in RFC 3339 format
- `external_id: optional string or null`
Platform's own identifier for this user. Not enforced unique.
- `name: optional string or null`
Display name of the entity this profile represents. For `resold` this is the resold-to company's name.
### Example
```http
curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: user-profiles-2026-03-24' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"external_id": "user_12345"
}'
```
#### Response
```json
{
"id": "uprof_011CZkZCu8hGbp5mYRQgUmz9",
"created_at": "2026-03-15T10:00:00Z",
"metadata": {},
"relationship": "external",
"trust_grants": {
"cyber": {
"status": "active"
}
},
"type": "user_profile",
"updated_at": "2026-03-15T10:00:00Z",
"external_id": "user_12345",
"name": "Example User"
}
```
api/beta/vaults First recorded · 4177 lines, first recorded
# Vaults ## Create Vault ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Vaults ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Vault ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Vault ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete Vault ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Vault ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Deleted Vault ### Beta Managed Agents Vault # Credentials ## Create Credential ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Credentials ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Credential ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Credential ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete Credential ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Credential ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Validate Credential ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Credential ### Beta Managed Agents Credential Networking Params ### Beta Managed Agents Credential Validation ### Beta Managed Agents Credential Validation Status ### Beta Managed Agents Deleted Credential ### Beta Managed Agents Environment Variable Auth Response ### Beta Managed Agents Environment Variable Create Params ### Beta Managed Agents Environment Variable Update Params ### Beta Managed Agents Injection Location Params ### Beta Managed Agents Injection Location Response ### Beta Managed Agents Injection Location Update Params ### Beta Managed Agents Limited Credential Networking Params ### Beta Managed Agents Limited Credential Networking Response ### Beta Managed Agents MCP OAuth Auth Response ### Beta Managed Agents MCP OAuth Create Params ### Beta Managed Agents MCP OAuth Refresh Params ### Beta Managed Agents MCP OAuth Refresh Response ### Beta Managed Agents MCP OAuth Refresh Update Params ### Beta Managed Agents MCP OAuth Update Params ### Beta Managed Agents MCP Probe ### Beta Managed Agents Refresh HTTP Response ### Beta Managed Agents Refresh Object ### Beta Managed Agents Static Bearer Auth Response ### Beta Managed Agents Static Bearer Create Params ### Beta Managed Agents Static Bearer Update Params ### Beta Managed Agents Token Endpoint Auth Basic Param ### Beta Managed Agents Token Endpoint Auth Basic Response ### Beta Managed Agents Token Endpoint Auth Basic Update Param ### Beta Managed Agents Token Endpoint Auth None Param ### Beta Managed Agents Token Endpoint Auth None Response ### Beta Managed Agents Token Endpoint Auth Post Param ### Beta Managed Agents Token Endpoint Auth Post Response ### Beta Managed Agents Token Endpoint Auth Post Update Param ### Beta Managed Agents Unrestricted Credential Networking Params ### Beta Managed Agents Unrestricted Credential Networking Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Vaults
url: https://platform.claude.com/docs/en/api/beta/vaults
---
# Vaults
## Create Vault
**post** `/v1/vaults`
Create Vault
### Header Parameters
- `"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 30 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"`
- `"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"`
### Body Parameters
- `display_name: string`
Human-readable name for the vault. 1-255 characters.
- `metadata: optional map[string]`
Arbitrary key-value metadata to attach to the vault. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
### Returns
- `BetaManagedAgentsVault object { id, archived_at, created_at, 4 more }`
A vault that stores credentials for use by agents during sessions.
- `id: string`
Unique identifier for the vault.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `display_name: string`
Human-readable name for the vault.
- `metadata: map[string]`
Arbitrary key-value metadata attached to the vault.
- `type: "vault"`
- `"vault"`
- `updated_at: string`
A timestamp in RFC 3339 format
### Example
```http
curl https://api.anthropic.com/v1/vaults \
-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 vault",
"metadata": {
"environment": "production"
}
}'
```
#### Response
```json
{
"id": "vlt_011CZkZDLs7fYzm1hXNPeRjv",
"archived_at": null,
"created_at": "2026-03-15T10:00:00Z",
"display_name": "Example vault",
"metadata": {
"environment": "production"
},
"type": "vault",
"updated_at": "2026-03-15T10:00:00Z"
}
```
## List Vaults
**get** `/v1/vaults`
List Vaults
### Query Parameters
- `include_archived: optional boolean`
Whether to include archived vaults in the results.
- `limit: optional number`
Maximum number of vaults to return per page. Defaults to 20, maximum 100.
- `page: optional string`
Opaque pagination token from a previous `list_vaults` response.
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `data: optional array of BetaManagedAgentsVault`
List of vaults.
- `id: string`
Unique identifier for the vault.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `display_name: string`
Human-readable name for the vault.
- `metadata: map[string]`
Arbitrary key-value metadata attached to the vault.
- `type: "vault"`
- `"vault"`
- `updated_at: string`
A timestamp in RFC 3339 format
- `next_page: optional string or null`
Pagination token for the next page, or null if no more results.
### Example
Cut at 300 lines. The page has the rest.
api/beta/vaults/archive First recorded · 150 lines, first recorded
## Archive Vault ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Archive Vault
url: https://platform.claude.com/docs/en/api/beta/vaults/archive
---
## Archive Vault
**post** `/v1/vaults/{vault_id}/archive`
Archive Vault
### Path Parameters
- `vault_id: string`
### Header Parameters
- `"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 30 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"`
- `"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"`
### Returns
- `BetaManagedAgentsVault object { id, archived_at, created_at, 4 more }`
A vault that stores credentials for use by agents during sessions.
- `id: string`
Unique identifier for the vault.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `display_name: string`
Human-readable name for the vault.
- `metadata: map[string]`
Arbitrary key-value metadata attached to the vault.
- `type: "vault"`
- `"vault"`
- `updated_at: string`
A timestamp in RFC 3339 format
### Example
```http
curl https://api.anthropic.com/v1/vaults/$VAULT_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
```json
{
"id": "vlt_011CZkZDLs7fYzm1hXNPeRjv",
"archived_at": null,
"created_at": "2026-03-15T10:00:00Z",
"display_name": "Example vault",
"metadata": {
"environment": "production"
},
"type": "vault",
"updated_at": "2026-03-15T10:00:00Z"
}
```
api/beta/vaults/create First recorded · 162 lines, first recorded
## Create Vault ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Create Vault
url: https://platform.claude.com/docs/en/api/beta/vaults/create
---
## Create Vault
**post** `/v1/vaults`
Create Vault
### Header Parameters
- `"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 30 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"`
- `"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"`
### Body Parameters
- `display_name: string`
Human-readable name for the vault. 1-255 characters.
- `metadata: optional map[string]`
Arbitrary key-value metadata to attach to the vault. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
### Returns
- `BetaManagedAgentsVault object { id, archived_at, created_at, 4 more }`
A vault that stores credentials for use by agents during sessions.
- `id: string`
Unique identifier for the vault.
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `display_name: string`
Human-readable name for the vault.
- `metadata: map[string]`
Arbitrary key-value metadata attached to the vault.
- `type: "vault"`
- `"vault"`
- `updated_at: string`
A timestamp in RFC 3339 format
### Example
```http
curl https://api.anthropic.com/v1/vaults \
-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 vault",
"metadata": {
"environment": "production"
}
}'
```
#### Response
```json
{
"id": "vlt_011CZkZDLs7fYzm1hXNPeRjv",
"archived_at": null,
"created_at": "2026-03-15T10:00:00Z",
"display_name": "Example vault",
"metadata": {
"environment": "production"
},
"type": "vault",
"updated_at": "2026-03-15T10:00:00Z"
}
```