Rate Limit Rules

Delete Rate Limit Rules

Delete all Rate Limit Rules in a configuration

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

Path parameters

config*Config

Response

200422

Rate Limit Rules deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully deleted entry"
}

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

config*Config

Response

200422

Rate Limit Rules version list retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of VersionEntry

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[e-mail]",
      "message": "text",
      "date": "2024-10-06T17:00:33.261Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

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

config*Config

version*Version

Response

200422

Rate Limit Rule reversion was successful

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}