Skip to main content
GET
/
api
/
v1
/
tunnel
/
{tunnel_id}
Get Tunnel Status Endpoint
curl --request GET \
  --url https://api.primeintellect.ai/api/v1/tunnel/{tunnel_id} \
  --header 'Authorization: Bearer <token>'
{
  "tunnel_id": "<string>",
  "hostname": "<string>",
  "url": "<string>",
  "local_port": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "user_id": "<string>",
  "name": "<string>",
  "labels": [
    "<string>"
  ],
  "connected_at": "2023-11-07T05:31:56Z",
  "terminated_at": "2023-11-07T05:31:56Z",
  "team_id": "<string>"
}

​
Rate Limit

300 requests per 60 seconds per tunnel.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tunnel_id
string
required

Response

Successful Response

Response containing tunnel status information.

​
tunnel_id
string
required

Unique tunnel identifier

​
status
enum<string>
required

Current tunnel status

Available options:
pending,
connected,
disconnected,
expired,
terminated
​
hostname
string
required

Tunnel hostname

​
url
string
required

Full HTTPS URL

​
local_port
integer
required

Local port forwarded by the tunnel

​
created_at
string<date-time>
required

Tunnel creation time

​
expires_at
string<date-time>
required

Token expiration time

​
user_id
string
required

Owner user ID

​
name
string | null

Friendly name if set

​
labels
string[]

Tunnel labels

​
connected_at
string<date-time> | null

When the client connected

​
terminated_at
string<date-time> | null

When the tunnel was terminated

​
team_id
string | null

Team ID if applicable