Skip to main content

Creates a new quota​

Creates a new quota

Path Parameters
  • instanceId string required
Request Body required
  • unit the unit a quota should be imposed on

    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

  • from date-time

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

  • resetInterval the quota periods duration

    the quota periods duration

  • amount uint64

    the quota amount of units

  • limit whether ZITADEL should block further usage when the configured amount is used

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

  • notifications object[]

    the handlers, ZITADEL executes when certain quota percentages are reached

  • Array [
  • percent int64

    The percentage relative to the quotas amount on which the call_url should be called.

  • repeat boolean

    If true, the call_url is called each time a factor of percentage is reached.

  • callUrl string

    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".

  • ]
Responses

A successful response.

Schema
  • details object
  • sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

  • resourceOwner resource_owner is the organization an object belongs to
Loading...