ZITADEL Docs
APIsCore ResourcesV1Instance Lifecycle

SetQuota

Sets quota configuration properties Creates a new quota if it doesn't exist for the specified unit

PUT
/instances/{instance_id}/quotas

Path Parameters

instance_id*string

Request Body

application/json

unit?string

the unit a quota should be imposed on

Value in"UNIT_UNIMPLEMENTED" | "UNIT_REQUESTS_ALL_AUTHENTICATED" | "UNIT_ACTIONS_ALL_RUN_SECONDS"
from?string

the starting time from which the current quota period is calculated from. This is relevant for querying the current usage.

Formatdate-time
resetInterval?string

the quota periods duration

Formatduration
amount?|

the quota amount of units

Formatint64
limit?boolean

whether Zitadel should block further usage when the configured amount is used

notifications?array<>

the handlers, Zitadel executes when certain quota percentages are reached

[key: string]?never

Response Body

application/json

curl -X PUT "https://loading/instances/string/quotas" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "sequence": 0,
    "creationDate": "2023-01-15T01:30:15.01Z",
    "changeDate": "2023-01-15T01:30:15.01Z",
    "resourceOwner": "string"
  }
}

Was this page helpful?

SetPrimaryDomain

Explore the SetPrimaryDomain operation in the ZITADEL API. Learn about request parameters, response schemas, and integration details for this endpoint.

Updates name of an existing instance

Updates name of an existing instance: Deprecated: Use [UpdateInstance](/reference/api/system/zitadel.system.v1.SystemService.UpdateInstance) instead to update the name of the instance in context