Rate Limit Rules

Get Rate Limit Rules

get

Get all Rate Limit Rules in a configuration

Path parameters

configstringRequired

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v4.0/conf/{config}/rate-limit-rules HTTP/1.1
Host: 
Accept: */*

200

Rate Limit Rules retrieved successfully

{
  "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
    }
  ]
}

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

objectOptional

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v4.0/conf/{config}/rate-limit-rules HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 298

[
  {
    "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
  }
]

{
  "message": "Successfully updated entry"
}

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

objectOptional

application/json

post

HTTPcURLJavaScriptPython

POST /api/v4.0/conf/{config}/rate-limit-rules HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 298

[
  {
    "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
  }
]

{
  "message": "Successfully created entry"
}

Delete Rate Limit Rules

delete

Delete all Rate Limit Rules in a configuration

Path parameters

configstringRequired

Responses

application/json

objectOptional

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v4.0/conf/{config}/rate-limit-rules HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get specific Rate Limit Rule

get

Get a Rate Limit Rule from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

GET /api/v4.0/conf/{config}/rate-limit-rules/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "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
}

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

objectOptional

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v4.0/conf/{config}/rate-limit-rules/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "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
}

{
  "message": "Successfully updated entry"
}

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

objectOptional

application/json

post

HTTPcURLJavaScriptPython

POST /api/v4.0/conf/{config}/rate-limit-rules/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "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
}

{
  "message": "Successfully created entry"
}

Delete single Rate Limit Rule

delete

Delete an individual Rate Limit Rule from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

application/json

objectOptional

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v4.0/conf/{config}/rate-limit-rules/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get Rate Limit Rules version list

get

Get list of versions of Rate Limit Rules in a configuration

Path parameters

configstringRequired

Responses

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

GET /api/v4.0/conf/{config}/rate-limit-rules/versions HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[e-mail]",
      "message": "text",
      "date": "2025-04-24T07:06:46.390Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Rate Limit Rule

get

Get a specific version of a Rate Limit Rule

Path parameters

configstringRequired

versionstringRequired

Responses

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

GET /api/v4.0/conf/{config}/rate-limit-rules/versions/{version} HTTP/1.1
Host: 
Accept: */*

{
  "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
    }
  ]
}

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

objectOptional

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v4.0/conf/{config}/rate-limit-rules/versions/{version}/revert HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully updated entry"
}