Skip to main content
GET
/
rentals
/
{rentalId}
/
stacks
/
{stackId}
/
containers
/
{containerId}
/
tunnel
Get container tunnel information
curl --request GET \
  --url https://api.gputrader.io/v1/rentals/{rentalId}/stacks/{stackId}/containers/{containerId}/tunnel \
  --header 'X-API-Key: <api-key>'
{
  "isBasicAuthEnabled": true,
  "url": "<string>",
  "username": "<string>",
  "password": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
rentalId
string
required

Rental ID

​
stackId
string
required

Stack ID

​
containerId
string
required

Container ID

Query Parameters

​
privatePort
string
required

Private port number for the tunnel

​
publicPort
string

Public port number for the tunnel (optional, will be removed in future)

Response

Successfully retrieved tunnel information

​
isBasicAuthEnabled
boolean
required

Indicates if basic authentication is enabled for the tunnel

​
url
string
required

Frontend endpoint URL for the tunnel

​
username
string

Frontend username (only present if basic auth is enabled)

​
password
string

Frontend password (only present if basic auth is enabled)