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

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, or be in standby) 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; standby does not count. A hard limit while billing is off for the org (billing_enabled on /v1/balance, off by default): the org's users get an email at 80 percent, and at 100 percent its running and standby sandboxes are stopped (their disks are kept) and none can start (403 quota_exceeded) or wake from standby until the next month. Once billing is on, the org's credit caps its usage instead and this does not apply.

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

Running sandbox-seconds this calendar month (UTC), all sizes counted alike; counted against monthly_sandbox_hours while billing is off.

roleRolerequired

What a user, and each of their API keys, may do in the org. owner: everything, including making and removing owners. admin: manages the members other than owners, every API key of the org and the vault on the website, and uses sandboxes. member: uses sandboxes, manages their own API keys and sees the vault's names. Every org has at least one owner.

Allowed:owneradminmember

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), insufficient_credit (402, no credit left to start a sandbox), forbidden (403), quota_exceeded (403), trial_limit (403, beyond what a trial org may run), not_found (404), conflict (409), billing_details_required (409, save the billing details before topping up), topup_not_available (409, the org cannot top up as it would be taxed; the message says why), withdrawal_consent_required (409, a consumer orders a top-up or the subscription only with withdrawal_consent), desktop_controlled (409, a person viewing the desktop has taken control of it, see control), rate_limited (429, see Retry-After), trial_capacity (429, all trial capacity in use; retry after Retry-After), host_capacity (429, the host is short of memory right now, so nothing new starts there; retry after Retry-After), internal (500), runtime_error (502, the sandbox host failed), payment_provider_error (502, Mollie could not be reached or refused a payment), unavailable (503, the feature is not configured on this deployment), waking (503, the sandbox is still waking from standby or booting; retry), timeout (504, or 408 when a request body stalls).

messagestringrequired

controlDesktopControl

Who has control of a sandbox's desktop. In an error, it is present only with code desktop_controlled.

Show properties

heldbooleanrequired

Someone viewing the desktop has taken control of it.

holderstring

Only when held; their name as the desktop's viewers see it, their user's name or else their API key's.

sincestring<date-time>

Only when held; when they took control.

expires_atstring<date-time>

Only when held; when control lapses unless they use the desktop before.

default

Error.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

controlDesktopControl

Who has control of a sandbox's desktop. In an error, it is present only with code desktop_controlled.

Show properties

heldbooleanrequired

Someone viewing the desktop has taken control of it.

holderstring

Only when held; their name as the desktop's viewers see it, their user's name or else their API key's.

sincestring<date-time>

Only when held; when they took control.

expires_atstring<date-time>

Only when held; when control lapses unless they use the desktop before.

Request

curl -X GET 'https://api.pols.so/v1/org' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.pols.so/v1/org", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.pols.so/v1/org",
    headers={
        "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
  },
  "role": "owner"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "control": {
      "held": true,
      "holder": "Ada",
      "since": "2019-08-24T14:15:22Z",
      "expires_at": "2019-08-24T14:15:22Z"
    }
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "control": {
      "held": true,
      "holder": "Ada",
      "since": "2019-08-24T14:15:22Z",
      "expires_at": "2019-08-24T14:15:22Z"
    }
  }
}