SPB Git

Repository Public

list.md 4.2 KB 196 lines markdown

1---2title: List Tunnels3url: https://platform.claude.com/docs/en/api/beta/tunnels/list4---56# List Tunnels78**GET** `/v1/tunnels`910The 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.1112Lists tunnels. Results are ordered by creation time, newest first; archived tunnels are excluded unless include_archived is set.1314## Query parameters1516- `include_archived: optional boolean`1718  Whether to include archived tunnels in the results. Defaults to false.1920- `limit: optional number`2122  Maximum number of tunnels to return per page. Defaults to 20, maximum 1000.2324  format: int322526- `page: optional string`2728  Opaque pagination cursor from a previous `list_tunnels` response.2930## Headers3132- `"anthropic-beta": optional array of AnthropicBeta`3334  Optional header to specify the beta version(s) you want to use.3536  - `string`3738  - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`3940    - `"message-batches-2024-09-24"`4142    - `"prompt-caching-2024-07-31"`4344    - `"computer-use-2024-10-22"`4546    - `"computer-use-2025-01-24"`4748    - `"pdfs-2024-09-25"`4950    - `"token-counting-2024-11-01"`5152    - `"token-efficient-tools-2025-02-19"`5354    - `"output-128k-2025-02-19"`5556    - `"files-api-2025-04-14"`5758    - `"mcp-client-2025-04-04"`5960    - `"mcp-client-2025-11-20"`6162    - `"dev-full-thinking-2025-05-14"`6364    - `"interleaved-thinking-2025-05-14"`6566    - `"code-execution-2025-05-22"`6768    - `"extended-cache-ttl-2025-04-11"`6970    - `"context-1m-2025-08-07"`7172    - `"context-management-2025-06-27"`7374    - `"model-context-window-exceeded-2025-08-26"`7576    - `"skills-2025-10-02"`7778    - `"fast-mode-2026-02-01"`7980    - `"output-300k-2026-03-24"`8182    - `"user-profiles-2026-03-24"`8384    - `"user-profiles-2026-08-18"`8586    - `"user-profiles-2026-09-04"`8788    - `"advisor-tool-2026-03-01"`8990    - `"managed-agents-2026-04-01"`9192    - `"cache-diagnosis-2026-04-07"`9394    - `"dreaming-2026-04-21"`9596    - `"thinking-token-count-2026-05-13"`9798    - `"server-side-fallback-2026-06-01"`99100    - `"server-side-fallback-2026-07-01"`101102    - `"fallback-credit-2026-06-01"`103104    - `"fallback-credit-2026-07-01"`105106    - `"agent-memory-2026-07-22"`107108    - `"mid-conversation-tool-changes-2026-07-01"`109110    - `"compact-2026-01-12"`111112    - `"computer-use-2025-11-24"`113114    - `"mcp-tunnels-2026-06-22"`115116    - `"structured-outputs-2025-11-13"`117118    - `"task-budgets-2026-03-13"`119120    - `"thinking-display-updates-2026-08-18"`121122    - `"ce-user-management-2026-07-13"`123124    - `"mid-conversation-output-config-2026-07-01"`125126    - `"thinking-binding-controls-2026-08-01"`127128    - `"mid-conversation-system-clear-at-2026-08-21"`129130    - `"compact-2026-09-04"`131132- `"anthropic-workspace-id": optional string`133134## Returns135136- `data: array of BetaTunnel`137138  List of tunnels, ordered by created_at descending.139140  - `type: "tunnel"`141142  - `id: string`143144    Unique identifier for the tunnel, prefixed with `tnl_`.145146  - `archived_at: string or null`147148    A timestamp in RFC 3339 format149150    format: date-time151152  - `created_at: string`153154    A timestamp in RFC 3339 format155156    format: date-time157158  - `display_name: string or null`159160    Human-readable name for the tunnel (1-255 characters). Null if unset.161162  - `domain: string`163164    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.165166- `next_page: string or null`167168  Pagination cursor for the next page, or null if no more results.169170## Example171172```bash173curl https://api.anthropic.com/v1/tunnels \174    -H 'anthropic-version: 2023-06-01' \175    -H 'anthropic-beta: mcp-tunnels-2026-06-22' \176    -H "X-Api-Key: $ANTHROPIC_API_KEY"177```178179### Response (200)180181```json182{183  "data": [184    {185      "id": "id",186      "archived_at": "2019-12-27T18:11:19.117Z",187      "created_at": "2019-12-27T18:11:19.117Z",188      "display_name": "display_name",189      "domain": "domain",190      "type": "tunnel"191    }192  ],193  "next_page": "next_page"194}195```196
Files main
Menu

Theme