HEhedra-labs
Sandboxes

Get a sandbox

Changed on

One sandbox with its instances and its charge so far.

get/sandboxes/{sandbox_id}

Request

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

Path parameters

sandbox_idstring required

The sandbox's id (sandbox_<uuid>).

Response

Successful Response

idstring required

The sandbox's id (sandbox_<uuid>).

namestring required

The sandbox's name, as created.

acceleratorstring required

The request's accelerator.

gpu_modelstring required

The accelerator's GPU model.

replicasinteger required

How many instances.

status'creating' | 'active' | 'stopping' | 'ended' | 'failed' required

Where a sandbox is in its life; stored in sandbox_billings.status.

end_reason'caller_stopped' | 'ttl_ended' | 'exited' | 'instance_failed' | 'unpaid' | 'lease_lapsed' | 'access_removed' | 'idle_ttl_ended' required

Why a sandbox ended, or, on an active one, that its last lease was refused.

created_atstring date-time required
started_atstring date-time nullable required

The earliest started_at of its instances; null on the list and before any instance starts.

ended_atstring date-time nullable required

When the last instance stopped; null until then.

ttl_ends_atstring date-time nullable required

When the sandbox's lifetime ends: created_at plus ttl_seconds; null for a sandbox created without ttl_seconds.

env_keysstring[] required

The keys of env, never its values.

imagestring nullable

The image the sandbox runs, as created. Set wherever instances is and the sandbox has an instance; null on the list, on the create answer, and while it has none.

commandstring[] nullable

The command the sandbox runs, as created and returned as given, so a secret belongs in env rather than here; null when image is, when the image's own ENTRYPOINT/CMD runs, and for an idle sandbox.

urlstring nullable

The address of the port in ports, the same for every replica; call it with a token from POST /sandboxes/{sandbox_id}/endpoint-token. Set wherever instances is; null on the list, for a sandbox created without ports, and while its pool serves no address.

Changes

  • 6ef35a11cefeRevision changes
    • warning

      added the new idle_ttl_ended 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

  • c482e691c208Revision changes
    • breaking

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