v48

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-0297180624.8 KB

Box

Web terminal url

This endpoint allows you to generate a pre-signed URL for accessing the web terminal of a running box. The URL is valid for a limited time and can be used to access the box's terminal interface.

post/boxes/{boxId}/web-terminal-url

Path parameters

boxIdstring required

Example:c9bdc193-b54b-4ddb-a035-5ac0c598d32d

Box ID

Request body

expiresInstring

The web terminal will be alive for the given duration

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: "500ms", "30s", "5m", "1h" Default: 180m

Example request

{
  "expiresIn": "180m"
}

Response

Generate pre-signed web terminal url

urlstring required

Web terminal url

Example response

{
  "url": "https://live.gbox.cloud/web-terminal/c9bdc193-b54b-4ddb-a035-5ac0c598d32d"
}