Rate Limit Rules

Get Rate Limit Rules

get

Get all Rate Limit Rules in a configuration

Path parameters

configstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/conf/{config}/rate-limit-rules'

200

200

{
  "total": 1,
  "items": [
    {
      "action": "text",
      "active": true,
      "description": "text",
      "exclude": {
        "relation": "OR",
        "tags": [
          "text"
        ]
      },
      "global": true,
      "id": "text",
      "include": {
        "relation": "OR",
        "tags": [
          "text"
        ]
      },
      "is_action_ban": true,
      "key": 1,
      "last_activated": 1,
      "name": "text",
      "pairwith": null,
      "tags": [
        "text"
      ],
      "threshold": 1,
      "timeframe": 1,
      "ttl": 1
    }
  ]
}

Rate Limit Rules retrieved successfully

Modify Rate Limit Rules

put

Update an existing set of Rate Limit Rules for a configuration

Path parameters

configstringrequired

Body

actionstringrequired

activebooleanrequired

descriptionstringoptional

excludeobjectrequired

globalbooleanrequired

idstringrequired

includeobjectrequired

is_action_banbooleanoptional

keyany ofoptional

last_activatedintegeroptional

namestringrequired

pairwithanyoptional

tagsstring[]optional

thresholdintegerrequired

timeframeintegerrequired

ttlintegeroptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/rate-limit-rules' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "action": "text",
      "active": true,
      "description": "text",
      "exclude": {
        "relation": "OR",
        "tags": [
          "text"
        ]
      },
      "global": true,
      "id": "text",
      "include": {
        "relation": "OR",
        "tags": [
          "text"
        ]
      },
      "is_action_ban": true,
      "key": 1,
      "last_activated": 1,
      "name": "text",
      "pairwith": null,
      "tags": [
        "text"
      ],
      "threshold": 1,
      "timeframe": 1,
      "ttl": 1
    }
  ]'

200

422

200

{
  "message": "Successfully updated entry"
}

Rate Limit Rules updated successfully

Create Rate Limit Rules

post

Create a complete set of Rate Limit Rules for a configuration

Path parameters

configstringrequired

Body

actionstringrequired

activebooleanrequired

descriptionstringoptional

excludeobjectrequired

globalbooleanrequired

idstringrequired

includeobjectrequired

is_action_banbooleanoptional

keyany ofoptional

last_activatedintegeroptional

namestringrequired

pairwithanyoptional

tagsstring[]optional

thresholdintegerrequired

timeframeintegerrequired

ttlintegeroptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/rate-limit-rules' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "action": "text",
      "active": true,
      "description": "text",
      "exclude": {
        "relation": "OR",
        "tags": [
          "text"
        ]
      },
      "global": true,
      "id": "text",
      "include": {
        "relation": "OR",
        "tags": [
          "text"
        ]
      },
      "is_action_ban": true,
      "key": 1,
      "last_activated": 1,
      "name": "text",
      "pairwith": null,
      "tags": [
        "text"
      ],
      "threshold": 1,
      "timeframe": 1,
      "ttl": 1
    }
  ]'

201

422

201

{
  "message": "Successfully created entry"
}

Rate Limit Rules created successfully

Delete Rate Limit Rules

delete

Delete all Rate Limit Rules in a configuration

Path parameters

configstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/rate-limit-rules'

200

422

200

{
  "message": "Successfully deleted entry"
}

Rate Limit Rules deleted successfully

Get specific Rate Limit Rule

get

Get a Rate Limit Rule from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}'

200

422

200

{
  "action": "text",
  "active": true,
  "description": "text",
  "exclude": {
    "relation": "OR",
    "tags": [
      "text"
    ]
  },
  "global": true,
  "id": "text",
  "include": {
    "relation": "OR",
    "tags": [
      "text"
    ]
  },
  "is_action_ban": true,
  "key": 1,
  "last_activated": 1,
  "name": "text",
  "pairwith": null,
  "tags": [
    "text"
  ],
  "threshold": 1,
  "timeframe": 1,
  "ttl": 1
}

Rate Limit Rule retrieved successfully

Modify a single Rate Limit Rule

put

Update an individual Rate Limit Rule within a configuration

Path parameters

configstringrequired

entry_idstringrequired

Body

actionstringrequired

activebooleanrequired

descriptionstringoptional

excludeobjectrequired

globalbooleanrequired

idstringrequired

includeobjectrequired

is_action_banbooleanoptional

keyany ofoptional

last_activatedintegeroptional

namestringrequired

pairwithanyoptional

tagsstring[]optional

thresholdintegerrequired

timeframeintegerrequired

ttlintegeroptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "action": "text",
    "active": true,
    "description": "text",
    "exclude": {
      "relation": "OR",
      "tags": [
        "text"
      ]
    },
    "global": true,
    "id": "text",
    "include": {
      "relation": "OR",
      "tags": [
        "text"
      ]
    },
    "is_action_ban": true,
    "key": 1,
    "last_activated": 1,
    "name": "text",
    "pairwith": null,
    "tags": [
      "text"
    ],
    "threshold": 1,
    "timeframe": 1,
    "ttl": 1
  }'

200

422

200

{
  "message": "Successfully updated entry"
}

Rate Limit Rule updated successfully

Create single Rate Limit Rule

post

Create an individual Rate Limit Rule within a configuration

Path parameters

configstringrequired

entry_idstringrequired

Body

actionstringrequired

activebooleanrequired

descriptionstringoptional

excludeobjectrequired

globalbooleanrequired

idstringrequired

includeobjectrequired

is_action_banbooleanoptional

keyany ofoptional

last_activatedintegeroptional

namestringrequired

pairwithanyoptional

tagsstring[]optional

thresholdintegerrequired

timeframeintegerrequired

ttlintegeroptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "action": "text",
    "active": true,
    "description": "text",
    "exclude": {
      "relation": "OR",
      "tags": [
        "text"
      ]
    },
    "global": true,
    "id": "text",
    "include": {
      "relation": "OR",
      "tags": [
        "text"
      ]
    },
    "is_action_ban": true,
    "key": 1,
    "last_activated": 1,
    "name": "text",
    "pairwith": null,
    "tags": [
      "text"
    ],
    "threshold": 1,
    "timeframe": 1,
    "ttl": 1
  }'

201

422

201

{
  "message": "Successfully created entry"
}

Rate Limit Rule created successfully

Delete single Rate Limit Rule

delete

Delete an individual Rate Limit Rule from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}'

200

422

200

{
  "message": "Successfully deleted entry"
}

Rate Limit Rule deleted successfully

Get Rate Limit Rules version list

get

Get list of versions of Rate Limit Rules in a configuration

Path parameters

configstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/conf/{config}/rate-limit-rules/versions'

200

422

200

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[e-mail]",
      "message": "text",
      "date": "2025-04-03T05:41:53.748Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Rate Limit Rules version list retrieved successfully

Get version of Rate Limit Rule

get

Get a specific version of a Rate Limit Rule

Path parameters

configstringrequired

versionstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/conf/{config}/rate-limit-rules/versions/{version}'

200

422

200

{
  "total": 1,
  "items": [
    {
      "action": "text",
      "active": true,
      "description": "text",
      "exclude": {
        "relation": "OR",
        "tags": [
          "text"
        ]
      },
      "global": true,
      "id": "text",
      "include": {
        "relation": "OR",
        "tags": [
          "text"
        ]
      },
      "is_action_ban": true,
      "key": 1,
      "last_activated": 1,
      "name": "text",
      "pairwith": null,
      "tags": [
        "text"
      ],
      "threshold": 1,
      "timeframe": 1,
      "ttl": 1
    }
  ]
}

Rate Limit Rule retrieved successfully

Revert a Rate Limit Rule to the specified version

put

Set a previous Rate Limit Rule version to be the current one

Path parameters

configstringrequired

versionstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/rate-limit-rules/versions/{version}/revert'

200

422

200

{
  "message": "Successfully updated entry"
}

Rate Limit Rule reversion was successful