Claude Platform Docs

Archiver un tunnel

client.beta.tunnels.archive(tunnelID, params?, options?): BetaTunnel
POST/v1/tunnels/{tunnel_id}/archive

L'API Tunnels est en « research preview » (aperçu de recherche). Elle nécessite l'en-tête anthropic-beta: mcp-tunnels-2026-06-22 et peut changer sans période de dépréciation. Elle remplace les points de terminaison de l'Admin API situés sous /v1/organizations/tunnels, qui restent disponibles pendant une fenêtre de migration.

Archive un tunnel. L'archivage est irréversible : chaque certificat non archivé du tunnel est archivé au cours de la même opération, le nom d'hôte est retiré et n'est jamais réalloué, et le jeton du tunnel est invalidé. Une nouvelle tentative sur un tunnel déjà archivé renvoie l'enregistrement existant sans modification.

Parameters
tunnelID: string⁠Path parameter

ID of the tunnel (tnl_...).

params: TunnelArchiveParams { betas; workspace_id }
betas?: Array<AnthropicBeta>⁠Header parameter

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

One of the following:
(string & {})
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
workspace_id?: string⁠Header parameter

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns
interface BetaTunnel { type: "tunnel"; id; archived_at; /* 3 more */ }

An MCP tunnel.

type: "tunnel"
id: string

Unique identifier for the tunnel, prefixed with tnl_.

archived_at: string | null

RFC 3339 datetime string indicating when the tunnel was archived. Null if it is not archived.

formatdate-time
created_at: string

RFC 3339 datetime string indicating when the tunnel was created.

formatdate-time
display_name: string | 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.

Archiver un tunnel
import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic({
  apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted
});

const betaTunnel = await client.beta.tunnels.archive("tunnel_id");

console.log(betaTunnel.id);
Returns Examples
Response 200
{
  "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"
}