Get tenant usages and quota¶

Method¶

GET https://papi.afi.ai/api/v1/tenants/{id}/quotas

Description¶

Retrieves tenant quota limits and usages by tenant ID.

Path params¶

id string required

ID of the tenant to retrieve quotas for.

curl

curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/tenants/{id}/quotas

Successful response (200) schema¶

object

TenantQuotas is a result of getting tenant quotas.

quotas array of objects

object

TenantQuota describes tenant usages and quota limits for a given quota kind.

kind string

Item kind covered by this quota item (resource (user), storage, node, etc.).

used uint64

Quota usage, i.e. how many item units are consumed.

limit uint64

Quota limit, i.e. max number of item units allowed to consume. If automatic license quantity adjustment is enabled then this limit equals to the auto-licensing limit. 4294967295 value means unlimited.

units string

Unit of measure used in this quota item (empty for resource/node quota kind, MB/GB for storage).

exceeded boolean

Flag indicating if quota limit is exceeded for this quota item. The service will be restricted upon exceeding a quota limit (some or all backups will start failing).

Response example¶

{
  "quotas": [
    {
      "kind": "string",
      "used": "uint64-as-string",
      "limit": "uint64-as-string",
      "units": "string",
      "exceeded": true
    }
  ]
}