Dynamic Rules

Get Dynamic Rules

Get all Dynamic Rules in a configuration

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

Path parameters

config*Config

Response

200400500

Dynamic Rules retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of DynamicRule

Request

JavaScriptCurlPython

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

Response

200400500

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

Get specific Dynamic Rule

Get a Dynamic Rule from the specified configuration

GET/api/v4.0/conf/{config}/dynamic-rules/{entry_id}

Path parameters

config*Config

entry_id*Entry ID

Response

200400422500

Dynamic Rule retrieved successfully

Body

application/json

action*Action

active*Active

descriptionDescription

id*Id

Unique id

Pattern: ^[A-Za-z0-9\-\_]*$

includeInclude

excludeExclude

name*Name

offload_ip_filtering*OffloadIPFiltering

tagsTags

target*Target

threshold*Threshold

timeframe*Timeframe

ttl*Ttl

Request

JavaScriptCurlPython

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

Response

200400422500

{
  "action": "text",
  "active": false,
  "description": "text",
  "id": "text",
  "include": {
    "relation": "OR",
    "tags": [
      "text"
    ]
  },
  "exclude": {
    "relation": "OR",
    "tags": [
      "text"
    ]
  },
  "name": "text",
  "offload_ip_filtering": false,
  "tags": [
    "text"
  ],
  "target": "text",
  "threshold": 0,
  "timeframe": 0,
  "ttl": 0
}

Modify Dynamic Rule

Update an individual Dynamic Rule within a configuration

PUT/api/v4.0/conf/{config}/dynamic-rules/{entry_id}

Path parameters

config*Config

entry_id*Id

Body

application/json

action*Action

active*Active

descriptionDescription

id*Id

Unique id

Pattern: ^[A-Za-z0-9\-\_]*$

includeInclude

excludeExclude

name*Name

offload_ip_filtering*OffloadIPFiltering

tagsTags

target*Target

threshold*Threshold

timeframe*Timeframe

ttl*Ttl

Response

200400422500

Dynamic Rule updated successfully

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}/dynamic-rules/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "threshold": 0,
      "timeframe": 0,
      "ttl": 0,
      "active": false,
      "offload_ip_filtering": false,
      "target": "text",
      "action": "text"
    }),
});
const data = await response.json();

Response

200400422500

{
  "message": "Successfully updated entry"
}

Create Dynamic Rule

Create an individual Dynamic Rule within a configuration

POST/api/v4.0/conf/{config}/dynamic-rules/{entry_id}

Path parameters

config*Config

entry_id*Id

Pattern: ^[A-Za-z0-9\-\_]*$

Body

application/json

action*Action

active*Active

descriptionDescription

id*Id

Unique id

Pattern: ^[A-Za-z0-9\-\_]*$

includeInclude

excludeExclude

name*Name

offload_ip_filtering*OffloadIPFiltering

tagsTags

target*Target

threshold*Threshold

timeframe*Timeframe

ttl*Ttl

Response

201400422500

Dynamic Rule created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

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

Response

201400422500

{
  "message": "Successfully created entry"
}

Delete Dynamic Rule

Delete an individual Dynamic Rule from the specified configuration

DELETE/api/v4.0/conf/{config}/dynamic-rules/{entry_id}

Path parameters

config*Config

entry_id*Id

Response

200400422500

Dynamic Rule 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}/dynamic-rules/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400422500

{
  "message": "Successfully deleted entry"
}