Reports used and licensed figures for entitlements, entitlement offers and catalog features.

GET

/api/v1/provision/admin/platform-quota/usage

curl --request GET \
  --url https://example.com/api/v1/provision/admin/platform-quota/usage

Responses

200

One entry per enforced count-based quota.

The tenant’s count-based Provision quotas: entitlements, entitlement offers and catalog features.

object

quotas

One entry per enforced quota.

Array<object>

One count-based platform quota: how many the tenant holds now, and how many its subscription allows. int QuotaUsageDto.Used is produced by the same count the enforcing gate performs, so a figure shown from it cannot disagree with the refusal the tenant would receive.

object

featureCode

The numeric license feature this quota is enforced on, e.g. entitlements.active.

string

name

Display name from the platform feature catalog.

string

used

Instances currently counted against the quota.

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

limit

The licensed ceiling. Zero when the caller bypasses licensing (sysadmin, or a token holding no-license-required) — there is no cap to render in that case, so treat it as unlimited rather than as a cap of nought.

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

canAddMore

Whether one more instance would still be within the licensed ceiling.

boolean

message

The refusal the gate would produce, or empty while there is room.

string

The tenant’s count-based Provision quotas: entitlements, entitlement offers and catalog features.

object

quotas

One entry per enforced quota.

Array<object>

One count-based platform quota: how many the tenant holds now, and how many its subscription allows. int QuotaUsageDto.Used is produced by the same count the enforcing gate performs, so a figure shown from it cannot disagree with the refusal the tenant would receive.

object

featureCode

The numeric license feature this quota is enforced on, e.g. entitlements.active.

string

name

Display name from the platform feature catalog.

string

used

Instances currently counted against the quota.

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

limit

The licensed ceiling. Zero when the caller bypasses licensing (sysadmin, or a token holding no-license-required) — there is no cap to render in that case, so treat it as unlimited rather than as a cap of nought.

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

canAddMore

Whether one more instance would still be within the licensed ceiling.

boolean

message

The refusal the gate would produce, or empty while there is room.

string

Example^generated

{
  "quotas": [
    {
      "featureCode": "example",
      "name": "example",
      "used": 1,
      "limit": 1,
      "canAddMore": true,
      "message": "example"
    }
  ]
}

The tenant’s count-based Provision quotas: entitlements, entitlement offers and catalog features.

object

quotas

One entry per enforced quota.

Array<object>

One count-based platform quota: how many the tenant holds now, and how many its subscription allows. int QuotaUsageDto.Used is produced by the same count the enforcing gate performs, so a figure shown from it cannot disagree with the refusal the tenant would receive.

object

featureCode

The numeric license feature this quota is enforced on, e.g. entitlements.active.

string

name

Display name from the platform feature catalog.

string

used

Instances currently counted against the quota.

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

limit

The licensed ceiling. Zero when the caller bypasses licensing (sysadmin, or a token holding no-license-required) — there is no cap to render in that case, so treat it as unlimited rather than as a cap of nought.

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

canAddMore

Whether one more instance would still be within the licensed ceiling.

boolean

message

The refusal the gate would produce, or empty while there is room.

string

Example^generated

{
  "quotas": [
    {
      "featureCode": "example",
      "name": "example",
      "used": 1,
      "limit": 1,
      "canAddMore": true,
      "message": "example"
    }
  ]
}