Docs
⌘K
Templates ›

List template sandboxes

GET/v1/templates/{id}/sandboxes

The sandboxes on the template, each with whether it has the template's variables, files and outbound rule as they are now, and the addresses of its own it may reach on top of the rule.

RequestTypeScript
  1. import { Agental } from "agental-sdk";
  3. const agental = new Agental();
  4. const template = await agental.templates.get("tpl_0123456789abcdef");
  5. const sandboxes = await template.sandboxes();
Answer200 OK · TemplateSandboxes
  1. {
  2. "sandboxes": [{
  3. "id": string,
  4. "name": string,
  5. "status": string,
  6. "upToDate": boolean,
  7. "takenAt": string | null,
  8. "allow": string[],
  9. }],
  10. }

Sandboxes on the template.

Path

idrequired
string
 e.g. "tpl_0123456789abcdef"

Headers

Authorizationrequired
Bearer key
An API key that may make this call.

Returns

200 Sandboxes on the template.

TemplateSandboxes1 field
sandboxes
object[]6 fields
id
string
name
string
status
string
upToDate
boolean
takenAt
stringnull
allow
string[]
The addresses it may reach on top of the template's outbound rule.

Errors and other answers

404 Not found.

Every error answers { "error": { "code", "message" } }; a key without the action a call needs answers 403 key_action_forbidden, naming it.

← Set template networkApply template →