Class Boxes

constructor

• new Boxes(client: GboxClient): GboxClient.V1.Boxes

  Parameters

  • client: GboxClient

  Returns GboxClient.V1.Boxes

actions

android

browser

fs

media

proxy

storage

createAndroid

• createAndroid(
      body: GboxClient.V1.BoxCreateAndroidParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.AndroidBox>

  Create android box

  Parameters

  • body: GboxClient.V1.BoxCreateAndroidParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.AndroidBox>

  Example

  const androidBox = await client.v1.boxes.createAndroid();
  Copy

createLinux

• createLinux(
      body: GboxClient.V1.BoxCreateLinuxParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.LinuxBox>

  Create linux box

  Parameters

  • body: GboxClient.V1.BoxCreateLinuxParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.LinuxBox>

  Example

  const linuxBox = await client.v1.boxes.createLinux();
  Copy

display

• display(
      boxID: string,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxDisplayResponse>

  Retrieve the current display properties for a running box. This endpoint provides details about the box's screen resolution, orientation, and other visual properties

  Parameters

  • boxID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxDisplayResponse>

  Example

  const response = await client.v1.boxes.display(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

executeCommands

• executeCommands(
      boxID: string,
      body: GboxClient.V1.BoxExecuteCommandsParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxExecuteCommandsResponse>

  Execute a command on a running box. This endpoint allows you to send commands to the box and receive the output

  Parameters

  • boxID: string
  • body: GboxClient.V1.BoxExecuteCommandsParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxExecuteCommandsResponse>

  Example

  const response = await client.v1.boxes.executeCommands(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
    { commands: ['ls', '-l'] },
  );
  Copy

list

• list(
      query?: undefined | null | GboxClient.V1.BoxListParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxListResponse>

  List box

  Parameters

  • query: undefined | null | GboxClient.V1.BoxListParams = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxListResponse>

  Example

  const boxes = await client.v1.boxes.list();
  Copy

liveViewURL

• liveViewURL(
      boxID: string,
      body?: undefined | null | GboxClient.V1.BoxLiveViewURLParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxLiveViewURLResponse>

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

  Parameters

  • boxID: string
  • body: undefined | null | GboxClient.V1.BoxLiveViewURLParams = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxLiveViewURLResponse>

  Example

  const response = await client.v1.boxes.liveViewURL(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

retrieve

• retrieve(
      boxID: string,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxRetrieveResponse>

  Get box

  Parameters

  • boxID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxRetrieveResponse>

  Example

  const box = await client.v1.boxes.retrieve(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

runCode

• runCode(
      boxID: string,
      body: GboxClient.V1.BoxRunCodeParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxRunCodeResponse>

  Run code on the box

  Parameters

  • boxID: string
  • body: GboxClient.V1.BoxRunCodeParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxRunCodeResponse>

  Example

  const response = await client.v1.boxes.runCode(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
    { code: 'print("Hello, World!")' },
  );
  Copy

start

• start(
      boxID: string,
      body?: undefined | null | GboxClient.V1.BoxStartParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxStartResponse>

  Start box

  Parameters

  • boxID: string
  • body: undefined | null | GboxClient.V1.BoxStartParams = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxStartResponse>

  Example

  const response = await client.v1.boxes.start(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

stop

• stop(
      boxID: string,
      body?: undefined | null | GboxClient.V1.BoxStopParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxStopResponse>

  Stop box

  Parameters

  • boxID: string
  • body: undefined | null | GboxClient.V1.BoxStopParams = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxStopResponse>

  Example

  const response = await client.v1.boxes.stop(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

terminate

• terminate(
      boxID: string,
      body?: undefined | null | GboxClient.V1.BoxTerminateParams,
      options?: RequestOptions,
  ): APIPromise<void>

  Terminate a running box. This action will stop the box and release its resources

  Parameters

  • boxID: string
  • body: undefined | null | GboxClient.V1.BoxTerminateParams = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<void>

  Example

  await client.v1.boxes.terminate(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

websocketURL

• websocketURL(
      boxID: string,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxWebsocketURLResponse>

  Get the websocket url for the box. This endpoint provides the WebSocket URLs for executing shell commands and running code snippets in the box environment. These URLs allow real-time communication and data exchange with the box, enabling interactive terminal sessions and code execution.

  Parameters

  • boxID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxWebsocketURLResponse>

  Example

  const response = await client.v1.boxes.websocketURL(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy

webTerminalURL

• webTerminalURL(
      boxID: string,
      body?: undefined | null | GboxClient.V1.BoxWebTerminalURLParams,
      options?: RequestOptions,
  ): APIPromise<GboxClient.V1.BoxWebTerminalURLResponse>

  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

  Parameters

  • boxID: string
  • body: undefined | null | GboxClient.V1.BoxWebTerminalURLParams = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<GboxClient.V1.BoxWebTerminalURLResponse>

  Example

  const response = await client.v1.boxes.webTerminalURL(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
  Copy