Sets quota configuration properties​
Creates a new quota if it doesn't exist for the specified unit
Sets quota configuration properties Creates a new quota if it doesn't exist for the specified unit
Path Parameters
Request Body required
- Array [
- ]
Possible values: [UNIT_UNIMPLEMENTED
, UNIT_REQUESTS_ALL_AUTHENTICATED
, UNIT_ACTIONS_ALL_RUN_SECONDS
]
Default value: UNIT_UNIMPLEMENTED
the unit a quota should be imposed on
the starting time from which the current quota period is calculated from. This is relevant for querying the current usage.
the quota periods duration
the quota amount of units
whether ZITADEL should block further usage when the configured amount is used
notifications object[]
the handlers, ZITADEL executes when certain quota percentages are reached
The percentage relative to the quotas amount on which the call_url should be called.
If true, the call_url is called each time a factor of percentage is reached.
The URL, which is called with HTTP method POST and a JSON payload with the properties "unit", "id" (notification id), "callURL", "periodStart", "threshold" and "usage".
Request Body required
- Array [
- ]
Possible values: [UNIT_UNIMPLEMENTED
, UNIT_REQUESTS_ALL_AUTHENTICATED
, UNIT_ACTIONS_ALL_RUN_SECONDS
]
Default value: UNIT_UNIMPLEMENTED
the unit a quota should be imposed on
the starting time from which the current quota period is calculated from. This is relevant for querying the current usage.
the quota periods duration
the quota amount of units
whether ZITADEL should block further usage when the configured amount is used
notifications object[]
the handlers, ZITADEL executes when certain quota percentages are reached
The percentage relative to the quotas amount on which the call_url should be called.
If true, the call_url is called each time a factor of percentage is reached.
The URL, which is called with HTTP method POST and a JSON payload with the properties "unit", "id" (notification id), "callURL", "periodStart", "threshold" and "usage".
Request Body required
- Array [
- ]
Possible values: [UNIT_UNIMPLEMENTED
, UNIT_REQUESTS_ALL_AUTHENTICATED
, UNIT_ACTIONS_ALL_RUN_SECONDS
]
Default value: UNIT_UNIMPLEMENTED
the unit a quota should be imposed on
the starting time from which the current quota period is calculated from. This is relevant for querying the current usage.
the quota periods duration
the quota amount of units
whether ZITADEL should block further usage when the configured amount is used
notifications object[]
the handlers, ZITADEL executes when certain quota percentages are reached
The percentage relative to the quotas amount on which the call_url should be called.
If true, the call_url is called each time a factor of percentage is reached.
The URL, which is called with HTTP method POST and a JSON payload with the properties "unit", "id" (notification id), "callURL", "periodStart", "threshold" and "usage".
- 200
- 403
- 404
- default
A successful response.
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:35.189Z",
"changeDate": "2024-06-13T06:44:35.189Z",
"resourceOwner": "69629023906488334"
}
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:35.189Z",
"changeDate": "2024-06-13T06:44:35.189Z",
"resourceOwner": "69629023906488334"
}
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:35.189Z",
"changeDate": "2024-06-13T06:44:35.189Z",
"resourceOwner": "69629023906488334"
}
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}