Get Tunnel

Get a tunnel in the workspace and the resources that reference it.

GET /workspaces/{workspace_id}/tunnels/{tunnel_id}

Error

A valid request URL is required to generate request examples

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "provider": "pangolin",
  "endpoint": "<string>",
  "client_id": "<string>",
  "allowed_targets": [
    {
      "host": "<string>",
      "ports": [
        32768
      ]
    }
  ],
  "enabled": true,
  "has_gateway_key": true,
  "managed": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "referenced_by": [
    {
      "kind": "mcp_integration",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

APIKeyCookieServiceAccountApiKeyBearer

fastapiusersauth · string · cookie · required

Path Parameters

tunnel_id · string<uuid> · required

workspace_id · string<uuid> · required

Response

200

application/json

Successful Response

A tunnel and the resources that reference it.

id · string<uuid> · required

workspace_id · string<uuid> · required

name · string · required

description · string | null · required

provider · enum<string> · required

Available options: pangolin

endpoint · string · required

client_id · string · required

allowed_targets · TunnelTarget · object[] · required

Show child attributes

enabled · boolean · required

has_gateway_key · boolean · required

managed · boolean · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

referenced_by · TunnelReference · object[] · required

MCP integrations, current agent preset versions and workflows that route through the tunnel. Each kind is capped at 200 entries.

Show child attributes