HEhedra-labs
Sandboxes

List sandboxes

Changed on

Your sandboxes in this workspace, newest first, without instances and started_at. A cursor resumes only under the name and live it was issued with.

get/sandboxes

Request

  • Base URL
    https://api.hedra.com/v3
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Query parameters

limitinteger

Maximum items per page.

cursorstring nullable

Opaque cursor from the previous page's next_cursor; omit for the first page.

namestring nullable

Only sandboxes with exactly this name. A name is unique among your creating, active and stopping sandboxes, so with live=true the page holds at most one.

liveboolean

With true, only creating, active and stopping sandboxes; with false, the default, sandboxes in every status.

Response

Successful Response

next_cursorstring nullable required

Opaque cursor for the next page, or null when this response completes the list. Always present. Endpoints that serve the whole collection at once always return null.

Changes

  • 6ef35a11cefeRevision changes
    • warning

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

    • info

      added the new optional query request parameter live

    • info

      added the new optional query request parameter name

    • info

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

    • info

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

  • c482e691c208Revision changes
    • breaking

      response property data/items/ttl_ends_at list-of-types was widened by adding types null to media type application/json of response 200