Create a new quota rule

POST

/admin/quota/rules

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Request Body

Definition of the quota rule

CreateQuotaRuleOptions represents the options for creating a quota rule

object

limit

The limit set by the rule

integer format: int64

name

Name of the rule to create

string

subjects

The subjects affected by the rule

Array<string>

Example^generated

{
  "limit": 1,
  "name": "example",
  "subjects": [
    "example"
  ]
}

CreateQuotaRuleOptions represents the options for creating a quota rule

object

limit

The limit set by the rule

integer format: int64

name

Name of the rule to create

string

subjects

The subjects affected by the rule

Array<string>

Responses

201

QuotaRuleInfo

Media typeapplication/json

QuotaRuleInfo contains information about a quota rule

object

limit

The limit set by the rule

integer format: int64

name

Name of the rule (only shown to admins)

string

subjects

Subjects the rule affects

Array<string>

Example^generated

{
  "limit": 1,
  "name": "example",
  "subjects": [
    "example"
  ]
}

400

APIError is error format response

Media typeapplication/json

APIError is an api error with a message

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}

403

APIForbiddenError is a forbidden error response

Media typeapplication/json

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}

409

APIError is error format response

Media typeapplication/json

APIError is an api error with a message

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}

422

APIValidationError is error format response related to input validation

Media typeapplication/json

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}