PRprimeintellect
Tunnel

Get Tunnel Status Endpoint

Changed on

Get status of a specific tunnel.

get/api/v1/tunnel/{tunnel_id}

Request

  • Base URL
    https://api.primeintellect.ai
  • Auth
    HTTP bearer

Path parameters

tunnel_idstring required

Response

Successful Response

tunnel_idstring required

Unique tunnel identifier

namestring nullable

Friendly name if set

status'pending' | 'connected' | 'disconnected' | 'expired' | 'terminated' required
hostnamestring required

Tunnel hostname

urlstring required

Full HTTPS URL

local_portinteger required

Local port forwarded by the tunnel

labelsstring[]

Tunnel labels

http_userstring nullable

HTTP basic auth username, if auth is enabled

auth_enabledboolean

Whether HTTP basic auth protects tunnel traffic

created_atstring date-time required

Tunnel creation time

connected_atstring date-time nullable

When the client connected

expires_atstring date-time required

Token expiration time

terminated_atstring date-time nullable

When the tunnel was terminated

user_idstring required

Owner user ID

team_idstring nullable

Team ID if applicable

Changes

  • bc121f7153d7Revision changes
    • warning

      added the new terminated enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 8277f2bd6e99Revision changes
    • info

      endpoint added