Skip to main content
GET
Get sandbox preferences

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id
string
required

The sandbox ID or URI to retrieve

Response

OK

name
string

The name of the sandbox

Minimum string length: 1
description
string

A description for the sandbox

topics
string[]
Maximum string length: 50
repo
string

A git repository URL to clone into the sandbox, e.g. a GitHub/Tangled repo.

vcpus
integer
Required range: x >= 1
memory
integer
Required range: x >= 1
disk
integer
Required range: x >= 3
readme
string<uri>

A URI to a README for the sandbox.