Skip to content
pols.so docs
Esc
↑↓navigate↵open⌘Jpreview

Save a sandbox's disk as a named template

Returns a creating template; poll GET until ready before using it. Failed saves remain visible until cleanup completes. Environment variables (secrets) of the source sandbox are not copied into the template. Answers 403 quota_exceeded when the org already has max_templates templates of its own.

POST/v1/templates
Authorization
AuthorizationBearer token · headerrequired

Org-scoped API key, pols_....

Request body
requiredapplication/json
sandboxstringrequired

Source sandbox ID or name. It must be running or stopped.

nameNamerequired

Lowercase letters, digits and dashes, starting with a letter.

matches ^[a-z][a-z0-9-]{0,62}$
descriptionstring

Free text, without control characters other than tab.

max length 500
Responses
201

The template.

statusTemplateStatusrequired
Allowed:creatingreadyfaileddeleting
disk_gibintegerrequired
min 1
idstringrequired
namestringrequired
descriptionstring | null
systembooleanrequired

Provided by pols.so for every org; cannot be deleted.

source_sandbox_idstring | null
created_atstring<date-time>required
429

Rate limited (rate_limited): too many requests or failed authentications from this address, too many requests or lifecycle calls for this org, or too many of its exec, file, computer and CDP calls in progress at once. Retry after Retry-After seconds.

errorobjectrequired
Show properties
codestringrequired

Stable machine-readable code: bad_request (400), unauthorized (401), forbidden (403), quota_exceeded (403), not_found (404), conflict (409), rate_limited (429, see Retry-After), internal (500), runtime_error (502, the sandbox host failed), unavailable (503, the feature is not configured on this deployment), timeout (504, or 408 when a request body stalls).

messagestringrequired
default

Error.

errorobjectrequired
Show properties
codestringrequired

Stable machine-readable code: bad_request (400), unauthorized (401), forbidden (403), quota_exceeded (403), not_found (404), conflict (409), rate_limited (429, see Retry-After), internal (500), runtime_error (502, the sandbox host failed), unavailable (503, the feature is not configured on this deployment), timeout (504, or 408 when a request body stalls).

messagestringrequired
Request
curl -X POST 'https://api.pols.so/v1/templates' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "sandbox": "string",
  "name": "string",
  "description": "string"
}'
Response
{
  "status": "creating",
  "disk_gib": 1,
  "id": "tpl_ubuntu2404",
  "name": "string",
  "description": "string",
  "system": true,
  "source_sandbox_id": "string",
  "created_at": "2019-08-24T14:15:22Z"
}