Docs
Account, keys and webhooks ›

Get limits

GET/v1/limits

Get limits.

RequestTypeScript
  1. import { Agental } from "agental-sdk";
  2. const agental = new Agental();
  3. const catalog = await agental.limits();
Answer200 OK · Catalog
  1. {
  2. "region": string,
  3. "regions": string[],
  4. "used": integer,
  5. "sizes": [{
  6. "name": "tiny" | "small" | "medium" | "large",
  7. "vcpu": integer,
  8. "memoryMb": integer,
  9. "diskGb": integer,
  10. }],
  11. "vmIsolation": boolean,
  12. }

The region, the sizes, and how many sandboxes it holds.

Headers

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

Returns

200 The region, the sizes, and how many sandboxes it holds.

Catalog5 fields
region
string
The default region: where a create that names none is made.
regions
string[]
The regions sandboxes can be made in now, the default first.
More GET /v1/regions says more of each.
used
integer
sizes
object[]4 fields
name
tinysmallmediumlarge
vcpu
integer
memoryMb
integer
diskGb
integer
vmIsolation
boolean
Whether sandboxes run in their own virtual machines.

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.