Skip to main content

Create a quota policy

Create a quota policy. POST /api/openapi/v1/quota-policies, scope admin.v1.quota.manage.

  • Scope: admin.v1.quota.manage
  • Permission: Manage quotas and metering (quota)
  • Permission type: Manage
  • Endpoint: POST/api/openapi/v1/quota-policies

Authentication and request headers

Call with an application API key. This endpoint checks only the scope above; read, manage and execute permissions do not imply one another.
NameLocationTypeRequiredDescriptionExample
AuthorizationheaderstringYesApplication API key, passed as a Bearer token.Bearer qwk_***
X-Request-IdheaderstringNoOptional request tracing identifier; generated by the server if omitted.req-20260831-001

Request parameters

NameLocationTypeRequiredDescriptionExample
descriptionbodystringNoDescription"<string>"
namebodystringRequiredPolicy name"<string>"
per_user_limitbodyinteger · int64RequiredCredit limit per user per cycle500
prioritybodyinteger · int64RequiredPriority0
scopesbodyarray | nullNoApplicable users[{"id":"<string>","type":"user"}]

Request example

cURL

Responses

201 Created
NameTypeRequiredDescriptionExample
created_atstring · date-timeYesCreated at"2026-08-27T10:00:00Z"
descriptionstringNoDescription"<string>"
idinteger · int64YesPolicy group ID0
is_defaultbooleanYesWhether this is the default policy groupfalse
namestringYesPolicy name"<string>"
per_user_limitinteger · int64YesPer-user allowance in whole credits0
priorityinteger · int64YesPriority0
scopesarray | nullYesApplicable users[{"id":"<string>","type":"user"}]
statusstringYesEnabled"enabled"
updated_atstring · date-timeYesUpdated at"2026-08-27T10:00:00Z"
Response example
default Flat business error
NameTypeRequiredDescriptionExample
codestringNoStable business error code"<string>"
detailstringYesHuman-readable error description"<string>"
detailsOpenapiErrorDetailsNoError details{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstringNoRequest field that failed validation"<string>"
details.reasonstringNoStable validation failure reason"<string>"
details.suggestionstringNoSuggested normalized value"<string>"
errorstringYesStable HTTP error type"<string>"
Response example