Templates ›
Get template start
GET
/v1/templates/{id}/startWhat a sandbox made from the template starts as: its size, a snapshot or a new machine, and how long it runs after each start.
RequestTypeScript
- import { Agental } from "agental-sdk";
- const agental = new Agental();
- const template = await agental.templates.get("tpl_0123456789abcdef");
- const start = await template.start();
Answer200 OK · TemplateStart
- {
- "size": "tiny" | "small" | "medium" | "large",
- "snapshotId": string | null,
- "ttlSeconds": integer | null,
- }
The template's start.
Path
idrequiredstring | e.g. "tpl_0123456789abcdef" |
Headers
AuthorizationrequiredBearer key | An API key that may make this call. |
Returns
200 The template's start.
TemplateStart3 fields
sizetinysmallmediumlarge
The size a sandbox made from the template is, when the create names none.
snapshotIdstringnull
The snapshot a sandbox made from the template starts as, when the create names none.
More
Null starts a new machine.ttlSecondsintegernull
Seconds a sandbox made from the template runs after each start before it is stopped, when the create names none.
More
Null is the deployment's default.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.