Sign in
sandboxes

List paginated Sandbox resources.

Changed on
get/api/sandbox

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/sandbox
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of items to return.

page_tokenstring

Opaque pagination token from a previous response.

sort_by'name' | 'created_at'

Resource field used to order results before pagination.

sort_order'asc' | 'desc'

Sort direction. Defaults to ascending when sort_by is set.

Headers

X-AgentZ-Workspace-IDstring

Stable Workspace ID selecting Workspace scope. Omit for Organisation scope.

Response

Paginated sandboxes.

next_page_tokenstring required

Changes

  • 61dc99f5fdaeRevision changes
    • info

      added the new optional query request parameter sort_by

    • info

      added the new optional query request parameter sort_order

  • f9e13a5159d6Revision changes
    • breaking

      the /// response property's maxLength was unset from 32 for the response status

    • breaking

      the /// response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the /// response's property type changed from string to object for status

    • info

      the endpoint scheme security GatewayBearer was added to the API

    • info

      added the new optional header request parameter X-AgentZ-Workspace-ID

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the /// response's property pattern ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ was removed for the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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