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

The org the API key belongs to, with its quotas and current consumption

GET/v1/org
Authorization
AuthorizationBearer token · headerrequired

Org-scoped API key, pols_....

Responses
200

The org.

idstringrequired
namestringrequired
created_atstring<date-time>required
quotasQuotasrequired
Show properties
max_running_sandboxesintegerrequired

Sandboxes that may run (or be starting) at the same time.

max_sandboxesintegerrequired

Sandboxes that may exist (running or stopped) at the same time.

monthly_sandbox_hoursintegerrequired

Running sandbox-hours per calendar month (UTC), all sizes counted equally. A hard limit: the org's owners get an email at 80 percent, and at 100 percent its running sandboxes are stopped (their disks are kept) and none can start until the next month.

max_templatesintegerrequired

The org's own templates (system templates do not count).

max_api_keysintegerrequired

API keys that are neither revoked nor expired.

usageOrgUsagerequired
Show properties
running_sandboxesintegerrequired
sandboxesintegerrequired
month_sandbox_secondsinteger<int64>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 GET 'https://api.pols.so/v1/org' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "id": "org_3k9x2m1q8zt4",
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "quotas": {
    "max_running_sandboxes": 0,
    "max_sandboxes": 0,
    "monthly_sandbox_hours": 0,
    "max_templates": 0,
    "max_api_keys": 0
  },
  "usage": {
    "running_sandboxes": 0,
    "sandboxes": 0,
    "month_sandbox_seconds": 0
  }
}