HYhyperbrowser
Sandboxes

Get list of sandboxes

Changed on
get/api/sandboxes

Request

Query parameters

pageinteger

Page number

limitinteger

Page size (max 100)

status'active' | 'stopping' | 'closed' | 'close-error' | 'error'

Filter by stored sandbox status. The active filter also includes GPU sandboxes that are provisioning; inspect each returned status. Provisioning is not accepted as a filter value.

startnumber

Filter by creation time (epoch milliseconds, inclusive lower bound)

endnumber

Filter by creation time (epoch milliseconds, inclusive upper bound)

searchstring

Search by sandbox ID

Response

Paginated list of sandboxes

totalCountinteger required
pageinteger required
perPageinteger required

Changes

  • 710eb2ccc708Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      response property sandboxes/items/endTime list-of-types was widened by adding types string to media type application/json of response 200

    • breaking

      response property sandboxes/items/startTime list-of-types was widened by adding types string to media type application/json of response 200

    • warning

      added the new provisioning enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • e006318be3f2Revision changes
    • warning

      added the new stopping enum value to the // response property for the response status

    • info

      added the new enum value stopping to the query request parameter status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status