Rate Limit Rules

Get Rate Limit Rules

Get all Rate Limit Rules in a configuration

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

Path parameters

config*Config

Response

Rate Limit Rules retrieved successfully

Body

totalinteger

Example: 1

itemsarray of RateLimit

Request

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

Response

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

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

config*Config

Body

action*Action

active*Active

descriptionDescription

exclude*Exclude

global*Global

id*Id

include*object

is_action_banIs Action Ban

keyKey

last_activatedLast Activated

name*Name

pairwithPairwith

tagsTags

threshold*Threshold

timeframe*Timeframe

ttlTtl

Response

Rate Limit Rules updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "global": false,
        "active": false,
        "timeframe": 0,
        "threshold": 0,
        "action": "text",
        "exclude": {},
        "include": {}
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

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

config*Config

Body

action*Action

active*Active

descriptionDescription

exclude*Exclude

global*Global

id*Id

include*object

is_action_banIs Action Ban

keyKey

last_activatedLast Activated

name*Name

pairwithPairwith

tagsTags

threshold*Threshold

timeframe*Timeframe

ttlTtl

Response

Rate Limit Rules created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "global": false,
        "active": false,
        "timeframe": 0,
        "threshold": 0,
        "action": "text",
        "exclude": {},
        "include": {}
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "Successfully created entry"
}

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

Rate Limit Rules deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

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

Response

{
  "message": "Successfully deleted entry"
}

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

config*Config

entry_id*Entry

Response

Rate Limit Rule retrieved successfully

Body

action*Action

active*Active

descriptionDescription

exclude*Exclude

global*Global

id*Id

include*object

is_action_banIs Action Ban

keyKey

last_activatedLast Activated

name*Name

pairwithPairwith

tagsTags

threshold*Threshold

timeframe*Timeframe

ttlTtl

Request

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

Response

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

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

config*Config

entry_id*Entry

Body

action*Action

active*Active

descriptionDescription

exclude*Exclude

global*Global

id*Id

include*object

is_action_banIs Action Ban

keyKey

last_activatedLast Activated

name*Name

pairwithPairwith

tagsTags

threshold*Threshold

timeframe*Timeframe

ttlTtl

Response

Rate Limit Rule updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "global": false,
      "active": false,
      "timeframe": 0,
      "threshold": 0,
      "action": "text",
      "exclude": {},
      "include": {}
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

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

config*Config

entry_id*Entry

Body

action*Action

active*Active

descriptionDescription

exclude*Exclude

global*Global

id*Id

include*object

is_action_banIs Action Ban

keyKey

last_activatedLast Activated

name*Name

pairwithPairwith

tagsTags

threshold*Threshold

timeframe*Timeframe

ttlTtl

Response

Rate Limit Rule created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/rate-limit-rules/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "global": false,
      "active": false,
      "timeframe": 0,
      "threshold": 0,
      "action": "text",
      "exclude": {},
      "include": {}
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully created entry"
}

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

config*Config

entry_id*Entry

Response

Rate Limit Rule deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

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

Response

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

Rate Limit Rules version list retrieved successfully

Body

totalinteger

Example: 1

itemsarray of VersionEntry

Request

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

Response

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2024-12-21T12:13:40.110Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

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

config*Config

version*Version

Response

Rate Limit Rule retrieved successfully

Body

totalinteger

Example: 1

itemsarray of RateLimit

Request

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

Response

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

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

Rate Limit Rule reversion was successful

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

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

Response

{
  "message": "Successfully updated entry"
}

PreviousProxy Templates NextSecurity Alerts

Last updated 18 days ago