Rate Limit Rules
Get all Rate Limit Rules in a configuration
Path parameters
configstringRequired
Responses
200
Rate Limit Rules retrieved successfully
application/json
get
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
}
]
}
Update an existing set of Rate Limit Rules for a configuration
Path parameters
configstringRequired
Body
actionstringRequired
activebooleanRequired
descriptionstringOptional
globalbooleanRequired
idstringRequired
is_action_banbooleanOptional
keyany ofOptional
integerOptional
numberOptional
booleanOptional
anyOptional
last_activatedintegerOptional
namestringRequired
pairwithanyOptional
tagsstring[]Optional
thresholdintegerRequired
timeframeintegerRequired
ttlintegerOptional
Responses
200
Rate Limit Rules updated successfully
application/json
422
Validation Error
application/json
put
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 a complete set of Rate Limit Rules for a configuration
Path parameters
configstringRequired
Body
actionstringRequired
activebooleanRequired
descriptionstringOptional
globalbooleanRequired
idstringRequired
is_action_banbooleanOptional
keyany ofOptional
integerOptional
numberOptional
booleanOptional
anyOptional
last_activatedintegerOptional
namestringRequired
pairwithanyOptional
tagsstring[]Optional
thresholdintegerRequired
timeframeintegerRequired
ttlintegerOptional
Responses
201
Rate Limit Rules created successfully
application/json
422
Validation Error
application/json
post
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 all Rate Limit Rules in a configuration
Path parameters
configstringRequired
Responses
200
Rate Limit Rules deleted successfully
application/json
422
Validation Error
application/json
delete
DELETE /api/v4.0/conf/{config}/rate-limit-rules HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}
Get a Rate Limit Rule from the specified configuration
Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Rate Limit Rule retrieved successfully
application/json
422
Validation Error
application/json
get
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
}
Update an individual Rate Limit Rule within a configuration
Path parameters
configstringRequired
entry_idstringRequired
Body
actionstringRequired
activebooleanRequired
descriptionstringOptional
globalbooleanRequired
idstringRequired
is_action_banbooleanOptional
keyany ofOptional
integerOptional
numberOptional
booleanOptional
anyOptional
last_activatedintegerOptional
namestringRequired
pairwithanyOptional
tagsstring[]Optional
thresholdintegerRequired
timeframeintegerRequired
ttlintegerOptional
Responses
200
Rate Limit Rule updated successfully
application/json
422
Validation Error
application/json
put
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 an individual Rate Limit Rule within a configuration
Path parameters
configstringRequired
entry_idstringRequired
Body
actionstringRequired
activebooleanRequired
descriptionstringOptional
globalbooleanRequired
idstringRequired
is_action_banbooleanOptional
keyany ofOptional
integerOptional
numberOptional
booleanOptional
anyOptional
last_activatedintegerOptional
namestringRequired
pairwithanyOptional
tagsstring[]Optional
thresholdintegerRequired
timeframeintegerRequired
ttlintegerOptional
Responses
201
Rate Limit Rule created successfully
application/json
422
Validation Error
application/json
post
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 an individual Rate Limit Rule from the specified configuration
Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Rate Limit Rule deleted successfully
application/json
422
Validation Error
application/json
delete
DELETE /api/v4.0/conf/{config}/rate-limit-rules/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}
Get list of versions of Rate Limit Rules in a configuration
Path parameters
configstringRequired
Responses
200
Rate Limit Rules version list retrieved successfully
application/json
422
Validation Error
application/json
get
GET /api/v4.0/conf/{config}/rate-limit-rules/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-06-30T22:59:05.084Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}
Get a specific version of a Rate Limit Rule
Path parameters
configstringRequired
versionstringRequired
Responses
200
Rate Limit Rule retrieved successfully
application/json
422
Validation Error
application/json
get
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
}
]
}
Set a previous Rate Limit Rule version to be the current one
Path parameters
configstringRequired
versionstringRequired
Responses
200
Rate Limit Rule reversion was successful
application/json
422
Validation Error
application/json
put
PUT /api/v4.0/conf/{config}/rate-limit-rules/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}
Last updated
Was this helpful?