Sandboxes

Get a sandbox

get/sandboxes/{id}

Request

  • Base URL: https://sandbox-as-a-service.com/v1
  • URL: https://sandbox-as-a-service.com/v1/sandboxes/{id}
  • Auth: HTTP bearer

Response

The sandbox.

object'sandbox'
idstring
namestring nullable
status'provisioning' | 'running' | 'deleting' | 'deleted' | 'failed'

Lifecycle state. Commands can only run while the sandbox is running.

size'small' | 'medium' | 'large'
timeout_minutesinteger
created_atstring date-time
ready_atstring date-time nullable
expires_atstring date-time nullable
deleted_atstring date-time nullable

Example response

{
  "id": "sbx_9f2c4a1b8d3e6f0a12",
  "name": "data-cleaning-job",
  "resources": {
    "vcpu": 2,
    "memory_gb": 4,
    "disk_gb": 40
  },
  "timeout_minutes": 15
}

Changes

No recorded changes to this operation across all 1 revision of this API.