Claude Platform Docs

Tunnels

Create Tunnel
client.beta.tunnels.create(TunnelCreateParamsparams, RequestOptionsoptions?): BetaTunnel
POST/v1/tunnels
Get Tunnel
client.beta.tunnels.retrieve(stringtunnelID, TunnelRetrieveParamsparams?, RequestOptionsoptions?): BetaTunnel
GET/v1/tunnels/{tunnel_id}
List Tunnels
client.beta.tunnels.list(TunnelListParamsparams?, RequestOptionsoptions?): PageCursor<BetaTunnel>
GET/v1/tunnels
Archive Tunnel
client.beta.tunnels.archive(stringtunnelID, TunnelArchiveParamsparams?, RequestOptionsoptions?): BetaTunnel
POST/v1/tunnels/{tunnel_id}/archive
Reveal Tunnel Token
client.beta.tunnels.revealToken(stringtunnelID, TunnelRevealTokenParamsparams?, RequestOptionsoptions?): BetaTunnelToken
POST/v1/tunnels/{tunnel_id}/reveal_token
Rotate Tunnel Token
client.beta.tunnels.rotateToken(stringtunnelID, TunnelRotateTokenParamsparams, RequestOptionsoptions?): BetaTunnelToken
POST/v1/tunnels/{tunnel_id}/rotate_token
Models
BetaTunnel { id, archived_at, created_at, 3 more }

An MCP tunnel.

id: string

Unique identifier for the tunnel, prefixed with tnl_.

archived_at: string | null

A timestamp in RFC 3339 format

formatdate-time
created_at: string

A timestamp in RFC 3339 format

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.

type: "tunnel"
BetaTunnelToken { 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"

TunnelsCertificates

Create Tunnel Certificate
client.beta.tunnels.certificates.create(stringtunnelID, CertificateCreateParamsparams, RequestOptionsoptions?): BetaTunnelCertificate
POST/v1/tunnels/{tunnel_id}/certificates
Get Tunnel Certificate
client.beta.tunnels.certificates.retrieve(stringcertificateID, CertificateRetrieveParamsparams, RequestOptionsoptions?): BetaTunnelCertificate
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
List Tunnel Certificates
client.beta.tunnels.certificates.list(stringtunnelID, CertificateListParamsparams?, RequestOptionsoptions?): PageCursor<BetaTunnelCertificate>
GET/v1/tunnels/{tunnel_id}/certificates
Archive Tunnel Certificate
client.beta.tunnels.certificates.archive(stringcertificateID, CertificateArchiveParamsparams, RequestOptionsoptions?): BetaTunnelCertificate
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive