Creates a new quota Returns an error if the quota already exists for the specified unit Deprecated: use SetQuota instead

POST 
/instances/:instanceId/quotas

Creates a new quota Returns an error if the quota already exists for the specified unit Deprecated: use SetQuota instead

Request

Path Parameters

instanceId stringrequired

application/json

Body

required

unit the unit a quota should be imposed on (string)

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 (string)

the quota periods duration

amount uint64

the quota amount of units

limit whether ZITADEL should block further usage when the configured amount is used (boolean)

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

]

application/grpc

Body

required

unit the unit a quota should be imposed on (string)

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 (string)

the quota periods duration

amount uint64

the quota amount of units

limit whether ZITADEL should block further usage when the configured amount is used (boolean)

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

]

application/grpc-web+proto

Body

required

unit the unit a quota should be imposed on (string)

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 (string)

the quota periods duration

amount uint64

the quota amount of units

limit whether ZITADEL should block further usage when the configured amount is used (boolean)

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

200

A successful response.

application/json

Schema

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 (string)

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-05T08:17:14.991Z",
    "changeDate": "2024-07-05T08:17:14.991Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc

Schema

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 (string)

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-05T08:17:14.991Z",
    "changeDate": "2024-07-05T08:17:14.991Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc-web+proto

Schema

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 (string)

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-05T08:17:14.991Z",
    "changeDate": "2024-07-05T08:17:14.991Z",
    "resourceOwner": "69629023906488334"
  }
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...