---
title: "Quota"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Service Quotas API

## Fields

- `Quota.adjustable` (boolean, required)
- `Quota.capacity` (integer | null, required) — rate quotas: the bucket's capacity for value (what usage.used is out of), else null.
  - min 0
- `Quota.default` (integer, required) — The default for the organization's tier.
  - min 0
- `Quota.description` (string, required)
- `Quota.displayName` (string, required)
- `Quota.id` (string, required) — <namespace>.<name> or <namespace>.<group>.<name>.
  - maxLength 96; pattern `^[a-z]{2,32}\.[a-z][A-Za-z0-9]{2,63}(\.[a-z][A-Za-z0-9]{1,63})?$`
- `Quota.kind` (unknown, required)
  - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
- `Quota.perRegion` (boolean, required)
- `Quota.region` (string, required) — A region (us-west-1), or "" for what isn't regional.
  - pattern `^([a-z]{2}-[a-z]+-[0-9]+)?$`
- `Quota.resourceType` (string | null, required)
- `Quota.scope` (unknown, required)
  - one of `"organization"`, `"project"`, `"resource"`
- `Quota.service` (string, required) — The owning product's namespace.
- `Quota.serviceName` (string | null, required) — The owning product's name, from its registration (Widgets), or null.
- `Quota.source` (unknown, required) — Which value applied: an override for the scope key, one for the whole organization, the tier's default, or the quota's default.
  - one of `"override"`, `"organizationOverride"`, `"tier"`, `"default"`
- `Quota.tier` (string | null, required) — The organization's tier when source is tier, else null.
- `Quota.unit` (string, required)
- `Quota.usage` (one of, required) — null for narrower scopes without ?scopeKey= (see usageSummary and the quota's scopes), and for a perRegion quota without ?region=.
  - one of: `null`, [Usage](/quotas-api/schemas/Usage/)
- `Quota.usageSummary` (one of, required) — When usage is null: where the scope keys (and regions) stand. Else null.
  - one of: `null`, [UsageSummary](/quotas-api/schemas/UsageSummary/)
- `Quota.value` (integer, required) — The value that applies: the organization's, a scope key without its own override's, or with ?scopeKey= that scope key's.
  - min 0
- `Quota.window` (string | null, required) — rate quotas: PT1S to PT1H.
- `Quota.scopes` (array<object>, required) — Every scope key with an override or known usage, or only ?scopeKey=; for a perRegion quota, a row per region (or only ?region=). An organization-scoped quota's scope key is the organization.
  - `Quota.scopes.capacity` (integer | null, required)
    - min 0
  - `Quota.scopes.region` (string, required) — A region (us-west-1), or "" for what isn't regional.
    - pattern `^([a-z]{2}-[a-z]+-[0-9]+)?$`
  - `Quota.scopes.scopeKey` (string, required) — A lowercase UUID.
    - pattern `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`
  - `Quota.scopes.source` (unknown, required) — Which value applied: an override for the scope key, one for the whole organization, the tier's default, or the quota's default.
    - one of `"override"`, `"organizationOverride"`, `"tier"`, `"default"`
  - `Quota.scopes.tier` (string | null, required)
  - `Quota.scopes.usage` (object, required)
    - `Quota.scopes.usage.periodStart` (one of, required) — usage quotas only.
      - one of: `null`, [Instant](/quotas-api/schemas/Instant/)
    - `Quota.scopes.usage.resetsAt` (one of, required) — usage quotas only.
      - one of: `null`, [Instant](/quotas-api/schemas/Instant/)
    - `Quota.scopes.usage.state` (unknown, required) — unavailable: the product (allocation) or Quotas' Redis didn't answer in time; never a stale number.
      - one of `"available"`, `"unavailable"`
    - `Quota.scopes.usage.used` (integer | null, required) — allocation: in use; usage: this billing period; concurrency: in flight; rate: tokens in use of the bucket's capacity (capacity minus whole tokens available), never above capacity. null when unavailable.
      - min 0
  - `Quota.scopes.value` (integer, required)
    - min 0
- `Quota.usageAvailable` (boolean, required) — false when some usage couldn't be read: rows known only from the product's usage are then missing, and rows shown have usage unavailable.


Source: https://docs.ezghcloud.com/quotas-api/schemas/Quota/index.md