Skip to content
StratumStratum Docs

An organization's quota allocation.

GET
/v1/organizations/{organizationId}/quotas
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/organizations/example/quotas \
  --header 'Authorization: Bearer <token>'

Per registered dimension: the operator’s ceiling on the sum over the org’s projects and the org’s usage, the org admin’s per-project default, and each project’s effective limit, source, allocation and usage. quotas:GetOrganizationQuotas on the organization (org members and billing hold it)..

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
organizationId
required
string
/^o-[a-z0-9-]+$/

Responses

Section titled “Responses”

200

Section titled “200”

The organization’s quota view.

Media typeapplication/json
object
items
required
Array<object>

One dimension of an organization’s quota view: the operator’s ceiling on the sum over the org’s projects, the org admin’s per-project default, and each project’s limit and usage.

object
dimension
required
string
service
required
string
unit
required
string
organizationLimit

The operator’s ceiling on the sum; absent = none.

integer
organizationUsage

The usage the organization’s ceiling is enforced against. It counts every project of the organization, including deleted ones that still hold resources, so it can exceed the sum of projects[].usage, which lists live projects only. Null when usage cannot be read.

integer
nullable
projectDefault

The org admin’s per-project default; absent = none.

integer
projects
required
Array<object>

One project’s line in an organization’s quota view.

object
projectId
required
string
limit
required

The project’s effective limit; -1 is unlimited.

integer
source
required

Where the limit comes from, as in EffectiveQuota.

string
usage
integer
nullable
allocation

The org admin’s allocation for this project, when set.

integer
enforced
required

False while the operator does not enforce this dimension’s service: every limit then reads -1 and nothing is refused.

boolean

Example generated

{
  "items": [
    {
      "dimension": "example",
      "service": "example",
      "unit": "example",
      "organizationLimit": 1,
      "organizationUsage": 1,
      "projectDefault": 1,
      "projects": [
        {
          "projectId": "example",
          "limit": 1,
          "source": "example",
          "usage": 1,
          "allocation": 1
        }
      ],
      "enforced": true
    }
  ]
}

403

Section titled “403”

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}