Create a new quota group

POST

/admin/quota/groups

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Request Body

Definition of the quota group

CreateQutaGroupOptions represents the options for creating a quota group

object

name

Name of the quota group to create

string

rules

Rules to add to the newly created group. If a rule does not exist, it will be created.

Array<object>

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

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

CreateQutaGroupOptions represents the options for creating a quota group

object

name

Name of the quota group to create

string

rules

Rules to add to the newly created group. If a rule does not exist, it will be created.

Array<object>

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

QuotaGroup

Media type application/json

QuotaGroup represents a quota group

object

name

Name of the group

string

rules

Rules associated with the group

Array<object>

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

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

400

APIError is error format response

Media type application/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 type application/json

object

message

string

url

string

Example ^generated

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

409

APIError is error format response

Media type application/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 type application/json

object

message

string

url

string

Example ^generated

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