The whole hunk
from line 1, old and new numbered
/
lines
from line 1
1---
2title: Tunnels
3url: https://platform.claude.com/docs/en/api/beta/tunnels
4---
5
16# Tunnels
27
38## Create Tunnel
from line 21
1621
1722 - `string`
1823
19 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2025
2126 - `"message-batches-2024-09-24"`
2227
from line 69
6469
6570 - `"user-profiles-2026-08-18"`
6671
72 - `"user-profiles-2026-09-04"`
73
6774 - `"advisor-tool-2026-03-01"`
6875
6976 - `"managed-agents-2026-04-01"`
from line 113
106113
107114 - `"mid-conversation-system-clear-at-2026-08-21"`
108115
116- `"anthropic-workspace-id": optional string`
117
109118### Body parameters
110119
111120- `display_name: optional string or null`
from line 129
120129
121130 An MCP tunnel.
122131
132 - `type: "tunnel"`
133
123134 - `id: string`
124135
125136 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 155
144155
145156 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.
146157
147 - `type: "tunnel"`
148
149158### Example
150159
151160```bash
from line 199
190199
191200 - `string`
192201
193 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
202 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
194203
195204 - `"message-batches-2024-09-24"`
196205
from line 247
238247
239248 - `"user-profiles-2026-08-18"`
240249
250 - `"user-profiles-2026-09-04"`
251
241252 - `"advisor-tool-2026-03-01"`
242253
243254 - `"managed-agents-2026-04-01"`
from line 291
280291
281292 - `"mid-conversation-system-clear-at-2026-08-21"`
282293
294- `"anthropic-workspace-id": optional string`
295
283296### Returns
284297
285298- `BetaTunnel object`
from line 299
286299
287300 An MCP tunnel.
288301
302 - `type: "tunnel"`
303
289304 - `id: string`
290305
291306 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 325
310325
311326 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.
312327
313 - `type: "tunnel"`
314
315328### Example
316329
317330```bash
from line 379
366379
367380 - `string`
368381
369 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
382 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
370383
371384 - `"message-batches-2024-09-24"`
372385
from line 427
414427
415428 - `"user-profiles-2026-08-18"`
416429
430 - `"user-profiles-2026-09-04"`
431
417432 - `"advisor-tool-2026-03-01"`
418433
419434 - `"managed-agents-2026-04-01"`
from line 471
456471
457472 - `"mid-conversation-system-clear-at-2026-08-21"`
458473
474- `"anthropic-workspace-id": optional string`
475
459476### Returns
460477
461478- `data: array of BetaTunnel`
from line 479
462479
463480 List of tunnels, ordered by created_at descending.
464481
482 - `type: "tunnel"`
483
465484 - `id: string`
466485
467486 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 505
486505
487506 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.
488507
489 - `type: "tunnel"`
490
491508- `next_page: string or null`
492509
493510 Pagination cursor for the next page, or null if no more results.
from line 556
539556
540557 - `string`
541558
542 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
559 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
543560
544561 - `"message-batches-2024-09-24"`
545562
from line 604
587604
588605 - `"user-profiles-2026-08-18"`
589606
607 - `"user-profiles-2026-09-04"`
608
590609 - `"advisor-tool-2026-03-01"`
591610
592611 - `"managed-agents-2026-04-01"`
from line 648
629648
630649 - `"mid-conversation-system-clear-at-2026-08-21"`
631650
651- `"anthropic-workspace-id": optional string`
652
632653### Returns
633654
634655- `BetaTunnel object`
from line 656
635656
636657 An MCP tunnel.
637658
659 - `type: "tunnel"`
660
638661 - `id: string`
639662
640663 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 682
659682
660683 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.
661684
662 - `type: "tunnel"`
663
664685### Example
665686
666687```bash
from line 725
704725
705726 - `string`
706727
707 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
728 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
708729
709730 - `"message-batches-2024-09-24"`
710731
from line 773
752773
753774 - `"user-profiles-2026-08-18"`
754775
776 - `"user-profiles-2026-09-04"`
777
755778 - `"advisor-tool-2026-03-01"`
756779
757780 - `"managed-agents-2026-04-01"`
from line 817
794817
795818 - `"mid-conversation-system-clear-at-2026-08-21"`
796819
820- `"anthropic-workspace-id": optional string`
821
797822### Returns
798823
799824- `BetaTunnelToken object`
from line 825
800825
801826 A tunnel's connector token.
802827
828 - `type: "tunnel_token"`
829
803830 - `id: string`
804831
805832 Stable identifier for the current token value. Changes when the token is rotated.
from line 835
808835
809836 The connector token used to run the tunnel. Treat as a credential.
810837
811 - `type: "tunnel_token"`
812
813838### Example
814839
815840```bash
from line 875
850875
851876 - `string`
852877
853 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
878 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
854879
855880 - `"message-batches-2024-09-24"`
856881
from line 923
898923
899924 - `"user-profiles-2026-08-18"`
900925
926 - `"user-profiles-2026-09-04"`
927
901928 - `"advisor-tool-2026-03-01"`
902929
903930 - `"managed-agents-2026-04-01"`
from line 967
940967
941968 - `"mid-conversation-system-clear-at-2026-08-21"`
942969
970- `"anthropic-workspace-id": optional string`
971
943972### Body parameters
944973
945974- `reason: optional string or null`
from line 983
954983
955984 A tunnel's connector token.
956985
986 - `type: "tunnel_token"`
987
957988 - `id: string`
958989
959990 Stable identifier for the current token value. Changes when the token is rotated.
from line 993
962993
963994 The connector token used to run the tunnel. Treat as a credential.
964995
965 - `type: "tunnel_token"`
966
967996### Example
968997
969998```bash
from line 1022
9931022
9941023 An MCP tunnel.
9951024
1025 - `type: "tunnel"`
1026
9961027 - `id: string`
9971028
9981029 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 1048
10171048
10181049 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.
10191050
1020 - `type: "tunnel"`
1021
10221051### Beta Tunnel Token
10231052
10241053- `BetaTunnelToken object`
from line 1054
10251054
10261055 A tunnel's connector token.
10271056
1057 - `type: "tunnel_token"`
1058
10281059 - `id: string`
10291060
10301061 Stable identifier for the current token value. Changes when the token is rotated.
from line 1064
10331064
10341065 The connector token used to run the tunnel. Treat as a credential.
10351066
1036 - `type: "tunnel_token"`
1037
10381067## Tunnels › Certificates
10391068
10401069### Create Tunnel Certificate
from line 1086
10571086
10581087 - `string`
10591088
1060 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1089 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
10611090
10621091 - `"message-batches-2024-09-24"`
10631092
from line 1134
11051134
11061135 - `"user-profiles-2026-08-18"`
11071136
1137 - `"user-profiles-2026-09-04"`
1138
11081139 - `"advisor-tool-2026-03-01"`
11091140
11101141 - `"managed-agents-2026-04-01"`
from line 1178
11471178
11481179 - `"mid-conversation-system-clear-at-2026-08-21"`
11491180
1181- `"anthropic-workspace-id": optional string`
1182
11501183#### Body parameters
11511184
11521185- `ca_certificate_pem: string`
from line 1194
11611194
11621195 A CA certificate attached to a tunnel.
11631196
1197 - `type: "tunnel_certificate"`
1198
11641199 - `id: string`
11651200
11661201 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 1226
11911226
11921227 ID of the tunnel the certificate is registered against.
11931228
1194 - `type: "tunnel_certificate"`
1195
11961229#### Example
11971230
11981231```bash
from line 1275
12421275
12431276 - `string`
12441277
1245 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1278 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
12461279
12471280 - `"message-batches-2024-09-24"`
12481281
from line 1323
12901323
12911324 - `"user-profiles-2026-08-18"`
12921325
1326 - `"user-profiles-2026-09-04"`
1327
12931328 - `"advisor-tool-2026-03-01"`
12941329
12951330 - `"managed-agents-2026-04-01"`
from line 1367
13321367
13331368 - `"mid-conversation-system-clear-at-2026-08-21"`
13341369
1370- `"anthropic-workspace-id": optional string`
1371
13351372#### Returns
13361373
13371374- `BetaTunnelCertificate object`
from line 1375
13381375
13391376 A CA certificate attached to a tunnel.
13401377
1378 - `type: "tunnel_certificate"`
1379
13411380 - `id: string`
13421381
13431382 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 1407
13681407
13691408 ID of the tunnel the certificate is registered against.
13701409
1371 - `type: "tunnel_certificate"`
1372
13731410#### Example
13741411
13751412```bash
from line 1466
14291466
14301467 - `string`
14311468
1432 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1469 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
14331470
14341471 - `"message-batches-2024-09-24"`
14351472
from line 1514
14771514
14781515 - `"user-profiles-2026-08-18"`
14791516
1517 - `"user-profiles-2026-09-04"`
1518
14801519 - `"advisor-tool-2026-03-01"`
14811520
14821521 - `"managed-agents-2026-04-01"`
from line 1558
15191558
15201559 - `"mid-conversation-system-clear-at-2026-08-21"`
15211560
1561- `"anthropic-workspace-id": optional string`
1562
15221563#### Returns
15231564
15241565- `data: array of BetaTunnelCertificate`
from line 1566
15251566
15261567 List of certificates, ordered by created_at descending.
15271568
1569 - `type: "tunnel_certificate"`
1570
15281571 - `id: string`
15291572
15301573 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 1598
15551598
15561599 ID of the tunnel the certificate is registered against.
15571600
1558 - `type: "tunnel_certificate"`
1559
15601601- `next_page: string or null`
15611602
15621603 Pagination cursor for the next page, or null if no more results.
from line 1652
16111652
16121653 - `string`
16131654
1614 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1655 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
16151656
16161657 - `"message-batches-2024-09-24"`
16171658
from line 1700
16591700
16601701 - `"user-profiles-2026-08-18"`
16611702
1703 - `"user-profiles-2026-09-04"`
1704
16621705 - `"advisor-tool-2026-03-01"`
16631706
16641707 - `"managed-agents-2026-04-01"`
from line 1744
17011744
17021745 - `"mid-conversation-system-clear-at-2026-08-21"`
17031746
1747- `"anthropic-workspace-id": optional string`
1748
17041749#### Returns
17051750
17061751- `BetaTunnelCertificate object`
from line 1752
17071752
17081753 A CA certificate attached to a tunnel.
17091754
1755 - `type: "tunnel_certificate"`
1756
17101757 - `id: string`
17111758
17121759 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 1783
17361783 - `tunnel_id: string`
17371784
17381785 ID of the tunnel the certificate is registered against.
1739
1740 - `type: "tunnel_certificate"`
17411786
17421787#### Example
17431788