Rate Limit Rules

PreviousProxy Templates NextSecurity Alerts

Last updated 2 months ago

Was this helpful?

Get Rate Limit Rules

Get all Rate Limit Rules in a configuration

get

/api/v4.0/conf/{config}/rate-limit-rules

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Rate Limit Rules retrieved successfully

Modify Rate Limit Rules

Update an existing set of Rate Limit Rules for a configuration

put

/api/v4.0/conf/{config}/rate-limit-rules

Path parameters

configConfigrequired

Body

actionActionrequired

activeActiverequired

descriptionDescription

globalGlobalrequired

idIdrequired

is_action_banIs Action Ban

last_activatedLast Activated

nameNamerequired

pairwithPairwith

thresholdThresholdrequired

timeframeTimeframerequired

ttlTtl

tagsTags

keyKey

excludeExcluderequired

includeobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "message": "Successfully updated entry"
}

Rate Limit Rules updated successfully

Create Rate Limit Rules

Create a complete set of Rate Limit Rules for a configuration

post

/api/v4.0/conf/{config}/rate-limit-rules

Path parameters

configConfigrequired

Body

actionActionrequired

activeActiverequired

descriptionDescription

globalGlobalrequired

idIdrequired

is_action_banIs Action Ban

last_activatedLast Activated

nameNamerequired

pairwithPairwith

thresholdThresholdrequired

timeframeTimeframerequired

ttlTtl

tagsTags

keyKey

excludeExcluderequired

includeobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

422

{
  "message": "Successfully created entry"
}

Rate Limit Rules created successfully

Delete Rate Limit Rules

Delete all Rate Limit Rules in a configuration

delete

/api/v4.0/conf/{config}/rate-limit-rules

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "message": "Successfully deleted entry"
}

Rate Limit Rules deleted successfully

Get specific Rate Limit Rule

Get a Rate Limit Rule from the specified configuration

get

/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

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

Rate Limit Rule retrieved successfully

Modify a single Rate Limit Rule

Update an individual Rate Limit Rule within a configuration

put

/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Body

actionActionrequired

activeActiverequired

descriptionDescription

globalGlobalrequired

idIdrequired

is_action_banIs Action Ban

last_activatedLast Activated

nameNamerequired

pairwithPairwith

thresholdThresholdrequired

timeframeTimeframerequired

ttlTtl

tagsTags

keyKey

excludeExcluderequired

includeobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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,"global":true,"id":"text","name":"text","threshold":1,"timeframe":1,"tags":[null],"exclude":{"relation":"OR","tags":["text"]},"include":{"relation":"OR","tags":["text"]}}'

200

422

{
  "message": "Successfully updated entry"
}

Rate Limit Rule updated successfully

Create single Rate Limit Rule

Create an individual Rate Limit Rule within a configuration

post

/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Body

actionActionrequired

activeActiverequired

descriptionDescription

globalGlobalrequired

idIdrequired

is_action_banIs Action Ban

last_activatedLast Activated

nameNamerequired

pairwithPairwith

thresholdThresholdrequired

timeframeTimeframerequired

ttlTtl

tagsTags

keyKey

excludeExcluderequired

includeobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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,"global":true,"id":"text","name":"text","threshold":1,"timeframe":1,"tags":[null],"exclude":{"relation":"OR","tags":["text"]},"include":{"relation":"OR","tags":["text"]}}'

201

422

{
  "message": "Successfully created entry"
}

Rate Limit Rule created successfully

Delete single Rate Limit Rule

Delete an individual Rate Limit Rule from the specified configuration

delete

/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "message": "Successfully deleted entry"
}

Rate Limit Rule deleted successfully

Get Rate Limit Rules version list

Get list of versions of Rate Limit Rules in a configuration

get

/api/v4.0/conf/{config}/rate-limit-rules/versions

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "hello@example.com",
      "message": "text",
      "date": "2025-02-21T18:02:58.324Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Rate Limit Rules version list retrieved successfully

Get version of Rate Limit Rule

Get a specific version of a Rate Limit Rule

get

/api/v4.0/conf/{config}/rate-limit-rules/versions/{version}

Path parameters

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

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

Rate Limit Rule retrieved successfully

Revert a Rate Limit Rule to the specified version

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

put

/api/v4.0/conf/{config}/rate-limit-rules/versions/{version}/revert

Path parameters

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "message": "Successfully updated entry"
}

Rate Limit Rule reversion was successful