Skip to main content
PATCH
/
api-auth
/
rate-limit-schemes
/
{slug}
Update rate limit scheme
curl --request PATCH \
  --url https://api.wacht.dev/api-auth/rate-limit-schemes/{slug} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "rules": [
    {
      "unit": "minute",
      "duration": 1,
      "max_requests": 100,
      "mode": "per_key",
      "endpoints": [
        "*"
      ],
      "priority": 0
    }
  ]
}
'
{
  "deployment_id": "<string>",
  "slug": "default-rate-limits",
  "name": "Default Rate Limits",
  "description": "<string>",
  "rules": [
    {
      "unit": "minute",
      "duration": 1,
      "max_requests": 100,
      "mode": "per_key",
      "endpoints": [
        "*"
      ],
      "priority": 0
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key authentication (format: Bearer {api_key})

Path Parameters

slug
string
required

Rate limit scheme slug

Body

application/json
name
string

New display name

description
string | null

New description

rules
object[]

Updated rate limit rules

Response

Rate limit scheme updated

deployment_id
string

Deployment ID

slug
string

Unique slug identifier

Example:

"default-rate-limits"

name
string

Display name

Example:

"Default Rate Limits"

description
string | null

Optional description

rules
object[]

Rate limit rules

created_at
string<date-time>
updated_at
string<date-time>