Skip to main content
GET
/
agents
/
{agentId}
/
tunnel
Get tunnel status
curl --request GET \
  --url https://core.cyberun.cloud/api/v1/agents/{agentId}/tunnel \
  --header 'Authorization: Bearer <token>'
{
  "is_active": true,
  "session_id": "<string>",
  "tunnel_url": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cyberun.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

User session JWT (Bearer ). Must be paired with the X-Team-ID request header on team-scoped endpoints so the server knows which team's resources to operate on.

Headers

X-Team-ID
string<uuid>

UUID of the team to scope the request to. Used by dual-auth endpoints (runtime + scoped management):

  • JWT callers MUST send it — a user may belong to multiple teams and the runtime cannot otherwise know which one to operate on. Missing header → 400.
  • Credential callers (sk-, dk-) can omit it because the team is derived from the credential row itself. Any value sent is ignored.
Example:

"019abc12-4567-7890-abcd-ef1234567891"

Path Parameters

agentId
string
required

Unique identifier of the agent.

Response

Tunnel status

is_active
boolean
required

Whether a tunnel is currently active for this agent.

session_id
string

Tunnel session ID (empty if no active tunnel).

tunnel_url
string

URL to access the tunneled service (empty if no active tunnel).