gbox_sdk.resources.v1 package¶

async create_android(*, config=<gbox_sdk.Omit object>, api_timeout=<gbox_sdk.Omit object>, wait=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Provisions a new Android box that you can operate through the GBOX SDK.

Use this endpoint when you want to create a fresh Android environment for testing, automation, or agent execution.

Return type:: AndroidBox

Args:

config: Configuration for a Android box instance

api_timeout: Timeout for waiting the box to transition from pending to running state, default

is 30s. If the box doesn’t reach running state within this timeout, the API will return HTTP status code 408. The timed-out box will be automatically deleted and will not count towards your quota.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 30s Maximum allowed: 5m

wait: Wait for the box operation to be completed, default is true

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async create_linux(*, config=<gbox_sdk.Omit object>, api_timeout=<gbox_sdk.Omit object>, wait=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Provisions a new Linux box that you can operate through the GBOX SDK.

Use this endpoint when you want to create a fresh Linux environment for testing, automation, or agent execution.

Return type:: LinuxBox

Args:

config: Configuration for a Linux box instance

api_timeout: Timeout for waiting the box to transition from pending to running state, default

is 30s. If the box doesn’t reach running state within this timeout, the API will return HTTP status code 408. The timed-out box will be automatically deleted and will not count towards your quota.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 30s Maximum allowed: 5m

wait: Wait for the box operation to be completed, default is true

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async display(box_id, *, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Retrieve the current display properties for a running box.

This endpoint provides details about the box’s screen resolution, orientation, and other visual properties.

Return type:: BoxDisplayResponse

Args:

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async execute_commands(box_id, *, command, envs=<gbox_sdk.Omit object>, api_timeout=<gbox_sdk.Omit object>, working_dir=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Execute a command on a running box.

This endpoint allows you to send commands to the box and receive the output

Return type:: BoxExecuteCommandsResponse

Args:

command: The command to run

envs: The environment variables to run the command

api_timeout: The timeout of the command. If the command times out, the exit code will be 124.

For example: ‘timeout 5s sleep 10s’ will result in exit code 124.

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

working_dir: The working directory of the command. It not provided, the command will be run

in the box.config.workingDir directory.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property fs: AsyncFsResource¶

async list(*, device_type=<gbox_sdk.Omit object>, labels=<gbox_sdk.Omit object>, page=<gbox_sdk.Omit object>, page_size=<gbox_sdk.Omit object>, status=<gbox_sdk.Omit object>, type=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Returns a paginated list of box instances.

Use this endpoint to monitor environments, filter by status or type, or retrieve boxes by labels or device type.

Return type:: BoxListResponse

Args:

device_type: Filter boxes by their device type (virtual, physical)

labels: Filter boxes by their labels. Labels are key-value pairs that help identify and: categorize boxes. Use this to filter boxes that match specific label criteria. For example, you can filter by project, environment, team, or any custom labels you’ve added to your boxes.

page: Page number

page_size: Page size

status: Filter boxes by their current status (pending, running, stopped, error,: terminated, all). Must be an array of statuses. Use ‘all’ to get boxes with any status.
type: Filter boxes by their type (linux, android, all). Must be an array of types. Use: ‘all’ to get boxes of any type.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async live_view_url(box_id, *, expires_in=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

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.

Return type:: BoxLiveViewURLResponse

Args:

expires_in: The live view 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

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property media: AsyncMediaResource¶

property proxy: AsyncProxyResource¶

async resolution_set(box_id, *, height, width, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Set the screen resolution

Return type:: BoxResolutionSetResponse

Args:

height: The height of the screen

width: The width of the screen

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async retrieve(box_id, *, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

This endpoint retrieves information about a box

Return type:: Union[LinuxBox, AndroidBox]

Args:

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async run_code(box_id, *, code, argv=<gbox_sdk.Omit object>, envs=<gbox_sdk.Omit object>, language=<gbox_sdk.Omit object>, api_timeout=<gbox_sdk.Omit object>, working_dir=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Executes code inside the specified box.

Supports multiple languages (bash, Python, TypeScript) and allows you to configure environment variables, arguments, working directory, and timeouts.

Return type:: BoxRunCodeResponse

Args:

code: The code to run

argv: The arguments to run the code. For example, if you want to run “python index.py: –help”, you should pass [”–help”] as arguments.

envs: The environment variables to run the code

language: The language of the code.

api_timeout: The timeout of the code execution. If the code execution times out, the exit

code will be 124.

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

working_dir: The working directory of the code. It not provided, the code will be run in the

box.config.workingDir directory.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async start(box_id, *, wait=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Start box

Return type:: Union[LinuxBox, AndroidBox]

Args:

wait: Wait for the box operation to be completed, default is true

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async stop(box_id, *, wait=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Stop box

Return type:: Union[LinuxBox, AndroidBox]

Args:

wait: Wait for the box operation to be completed, default is true

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property storage: AsyncStorageResource¶

async terminate(box_id, *, wait=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Terminate a running box.

This action will stop the box and release its resources.

Return type:: None

Args:

wait: Wait for the box operation to be completed, default is true

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async web_terminal_url(box_id, *, expires_in=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

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.

Return type:: BoxWebTerminalURLResponse

Args:

expires_in: 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

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async websocket_url(box_id, *, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

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.

Return type:: BoxWebsocketURLResponse

Args:

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property with_raw_response: AsyncBoxesResourceWithRawResponse¶

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://www.github.com/babelcloud/gbox-sdk-py#accessing-raw-response-data-eg-headers

property with_streaming_response: AsyncBoxesResourceWithStreamingResponse¶

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://www.github.com/babelcloud/gbox-sdk-py#with_streaming_response

class gbox_sdk.resources.v1.AsyncBoxesResourceWithRawResponse(boxes)¶

Bases: object

property actions: AsyncActionsResourceWithRawResponse¶

property android: AsyncAndroidResourceWithRawResponse¶

property browser: AsyncBrowserResourceWithRawResponse¶

property fs: AsyncFsResourceWithRawResponse¶

property media: AsyncMediaResourceWithRawResponse¶

property proxy: AsyncProxyResourceWithRawResponse¶

property storage: AsyncStorageResourceWithRawResponse¶

class gbox_sdk.resources.v1.AsyncBoxesResourceWithStreamingResponse(boxes)¶

Bases: object

property actions: AsyncActionsResourceWithStreamingResponse¶

property android: AsyncAndroidResourceWithStreamingResponse¶

property browser: AsyncBrowserResourceWithStreamingResponse¶

property fs: AsyncFsResourceWithStreamingResponse¶

property media: AsyncMediaResourceWithStreamingResponse¶

property proxy: AsyncProxyResourceWithStreamingResponse¶

property storage: AsyncStorageResourceWithStreamingResponse¶

class gbox_sdk.resources.v1.AsyncDevicesResource(client)¶

Bases: AsyncAPIResource

async get(device_id, *, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Get device info

Return type:: DeviceInfo

Args:

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async list(*, x_device_ap, page=<gbox_sdk.Omit object>, page_size=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Get device list

Return type:: GetDeviceListResponse

Args:

page: Page number

page_size: Page size

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

async to_box(device_id, *, force=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Create a new box using a physical device

Return type:: str

Args:

force: If true, the device will be forcibly created as a new Box, which will forcibly: terminate any existing box that is currently using this device. If false, an error will be thrown with HTTP 423 status code when the device is already occupied by a box.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property with_raw_response: AsyncDevicesResourceWithRawResponse¶

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://www.github.com/babelcloud/gbox-sdk-py#accessing-raw-response-data-eg-headers

property with_streaming_response: AsyncDevicesResourceWithStreamingResponse¶

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://www.github.com/babelcloud/gbox-sdk-py#with_streaming_response

class gbox_sdk.resources.v1.AsyncDevicesResourceWithRawResponse(devices)¶: Bases: object

class gbox_sdk.resources.v1.AsyncDevicesResourceWithStreamingResponse(devices)¶: Bases: object

class gbox_sdk.resources.v1.AsyncV1Resource(client)¶

Bases: AsyncAPIResource

property boxes: AsyncBoxesResource¶

property devices: AsyncDevicesResource¶

property with_raw_response: AsyncV1ResourceWithRawResponse¶

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://www.github.com/babelcloud/gbox-sdk-py#accessing-raw-response-data-eg-headers

property with_streaming_response: AsyncV1ResourceWithStreamingResponse¶

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://www.github.com/babelcloud/gbox-sdk-py#with_streaming_response

class gbox_sdk.resources.v1.AsyncV1ResourceWithRawResponse(v1)¶

Bases: object

property boxes: AsyncBoxesResourceWithRawResponse¶

property devices: AsyncDevicesResourceWithRawResponse¶

class gbox_sdk.resources.v1.AsyncV1ResourceWithStreamingResponse(v1)¶

Bases: object

property boxes: AsyncBoxesResourceWithStreamingResponse¶

property devices: AsyncDevicesResourceWithStreamingResponse¶

class gbox_sdk.resources.v1.BoxesResource(client)¶

Bases: SyncAPIResource

property actions: ActionsResource¶

property android: AndroidResource¶

property browser: BrowserResource¶

create_android(*, config=<gbox_sdk.Omit object>, api_timeout=<gbox_sdk.Omit object>, wait=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Provisions a new Android box that you can operate through the GBOX SDK.

Use this endpoint when you want to create a fresh Android environment for testing, automation, or agent execution.

Return type:: AndroidBox

Args:

config: Configuration for a Android box instance

api_timeout: Timeout for waiting the box to transition from pending to running state, default

is 30s. If the box doesn’t reach running state within this timeout, the API will return HTTP status code 408. The timed-out box will be automatically deleted and will not count towards your quota.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 30s Maximum allowed: 5m

wait: Wait for the box operation to be completed, default is true

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

create_linux(*, config=<gbox_sdk.Omit object>, api_timeout=<gbox_sdk.Omit object>, wait=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Provisions a new Linux box that you can operate through the GBOX SDK.

Use this endpoint when you want to create a fresh Linux environment for testing, automation, or agent execution.

Return type:: LinuxBox

Args:

config: Configuration for a Linux box instance

api_timeout: Timeout for waiting the box to transition from pending to running state, default

is 30s. If the box doesn’t reach running state within this timeout, the API will return HTTP status code 408. The timed-out box will be automatically deleted and will not count towards your quota.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: “500ms”, “30s”, “5m”, “1h” Default: 30s Maximum allowed: 5m

wait: Wait for the box operation to be completed, default is true

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

display(box_id, *, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Retrieve the current display properties for a running box.

This endpoint provides details about the box’s screen resolution, orientation, and other visual properties.

Return type:: BoxDisplayResponse

Args:

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

execute_commands(box_id, *, command, envs=<gbox_sdk.Omit object>, api_timeout=<gbox_sdk.Omit object>, working_dir=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Execute a command on a running box.

This endpoint allows you to send commands to the box and receive the output

Return type:: BoxExecuteCommandsResponse

Args:

command: The command to run

envs: The environment variables to run the command

api_timeout: The timeout of the command. If the command times out, the exit code will be 124.

For example: ‘timeout 5s sleep 10s’ will result in exit code 124.

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

working_dir: The working directory of the command. It not provided, the command will be run

in the box.config.workingDir directory.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property fs: FsResource¶

list(*, device_type=<gbox_sdk.Omit object>, labels=<gbox_sdk.Omit object>, page=<gbox_sdk.Omit object>, page_size=<gbox_sdk.Omit object>, status=<gbox_sdk.Omit object>, type=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Returns a paginated list of box instances.

Use this endpoint to monitor environments, filter by status or type, or retrieve boxes by labels or device type.

Return type:: BoxListResponse

Args:

device_type: Filter boxes by their device type (virtual, physical)

labels: Filter boxes by their labels. Labels are key-value pairs that help identify and: categorize boxes. Use this to filter boxes that match specific label criteria. For example, you can filter by project, environment, team, or any custom labels you’ve added to your boxes.

page: Page number

page_size: Page size

status: Filter boxes by their current status (pending, running, stopped, error,: terminated, all). Must be an array of statuses. Use ‘all’ to get boxes with any status.
type: Filter boxes by their type (linux, android, all). Must be an array of types. Use: ‘all’ to get boxes of any type.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

live_view_url(box_id, *, expires_in=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

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.

Return type:: BoxLiveViewURLResponse

Args:

expires_in: The live view 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

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property media: MediaResource¶

property proxy: ProxyResource¶

resolution_set(box_id, *, height, width, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Set the screen resolution

Return type:: BoxResolutionSetResponse

Args:

height: The height of the screen

width: The width of the screen

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

retrieve(box_id, *, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

This endpoint retrieves information about a box

Return type:: Union[LinuxBox, AndroidBox]

Args:

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

run_code(box_id, *, code, argv=<gbox_sdk.Omit object>, envs=<gbox_sdk.Omit object>, language=<gbox_sdk.Omit object>, api_timeout=<gbox_sdk.Omit object>, working_dir=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Executes code inside the specified box.

Supports multiple languages (bash, Python, TypeScript) and allows you to configure environment variables, arguments, working directory, and timeouts.

Return type:: BoxRunCodeResponse

Args:

code: The code to run

argv: The arguments to run the code. For example, if you want to run “python index.py: –help”, you should pass [”–help”] as arguments.

envs: The environment variables to run the code

language: The language of the code.

api_timeout: The timeout of the code execution. If the code execution times out, the exit

code will be 124.

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

working_dir: The working directory of the code. It not provided, the code will be run in the

box.config.workingDir directory.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

start(box_id, *, wait=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Start box

Return type:: Union[LinuxBox, AndroidBox]

Args:

wait: Wait for the box operation to be completed, default is true

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

stop(box_id, *, wait=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Stop box

Return type:: Union[LinuxBox, AndroidBox]

Args:

wait: Wait for the box operation to be completed, default is true

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property storage: StorageResource¶

terminate(box_id, *, wait=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Terminate a running box.

This action will stop the box and release its resources.

Return type:: None

Args:

wait: Wait for the box operation to be completed, default is true

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

web_terminal_url(box_id, *, expires_in=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

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.

Return type:: BoxWebTerminalURLResponse

Args:

expires_in: 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

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

websocket_url(box_id, *, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

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.

Return type:: BoxWebsocketURLResponse

Args:

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property with_raw_response: BoxesResourceWithRawResponse¶

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://www.github.com/babelcloud/gbox-sdk-py#accessing-raw-response-data-eg-headers

property with_streaming_response: BoxesResourceWithStreamingResponse¶

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://www.github.com/babelcloud/gbox-sdk-py#with_streaming_response

class gbox_sdk.resources.v1.BoxesResourceWithRawResponse(boxes)¶

Bases: object

property actions: ActionsResourceWithRawResponse¶

property android: AndroidResourceWithRawResponse¶

property browser: BrowserResourceWithRawResponse¶

property fs: FsResourceWithRawResponse¶

property media: MediaResourceWithRawResponse¶

property proxy: ProxyResourceWithRawResponse¶

property storage: StorageResourceWithRawResponse¶

class gbox_sdk.resources.v1.BoxesResourceWithStreamingResponse(boxes)¶

Bases: object

property actions: ActionsResourceWithStreamingResponse¶

property android: AndroidResourceWithStreamingResponse¶

property browser: BrowserResourceWithStreamingResponse¶

property fs: FsResourceWithStreamingResponse¶

property media: MediaResourceWithStreamingResponse¶

property proxy: ProxyResourceWithStreamingResponse¶

property storage: StorageResourceWithStreamingResponse¶

class gbox_sdk.resources.v1.DevicesResource(client)¶

Bases: SyncAPIResource

get(device_id, *, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Get device info

Return type:: DeviceInfo

Args:

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

list(*, x_device_ap, page=<gbox_sdk.Omit object>, page_size=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Get device list

Return type:: GetDeviceListResponse

Args:

page: Page number

page_size: Page size

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

to_box(device_id, *, force=<gbox_sdk.Omit object>, extra_headers=None, extra_query=None, extra_body=None, timeout=NOT_GIVEN)¶

Create a new box using a physical device

Return type:: str

Args:

force: If true, the device will be forcibly created as a new Box, which will forcibly: terminate any existing box that is currently using this device. If false, an error will be thrown with HTTP 423 status code when the device is already occupied by a box.

extra_headers: Send extra headers

extra_query: Add additional query parameters to the request

extra_body: Add additional JSON properties to the request

timeout: Override the client-level default timeout for this request, in seconds

property with_raw_response: DevicesResourceWithRawResponse¶

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://www.github.com/babelcloud/gbox-sdk-py#accessing-raw-response-data-eg-headers

property with_streaming_response: DevicesResourceWithStreamingResponse¶

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://www.github.com/babelcloud/gbox-sdk-py#with_streaming_response