Dynamic Rules

Get Dynamic Rules

get

Get all Dynamic Rules in a configuration

Path parameters

configstringRequired

Responses

200

Dynamic Rules retrieved successfully

application/json

totalintegerOptionalExample: 1

400

Input Error

application/json

500

Internal Server Error

application/json

get/api/v4.3/conf/{config}/dynamic-rules

GET /api/v4.3/conf/{config}/dynamic-rules HTTP/1.1
Accept: */*

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

Get specific Dynamic Rule

get

Get a Dynamic Rule from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Dynamic Rule retrieved successfully

application/json

actionstringRequired

activebooleanRequired

descriptionstringOptionalDefault: ""

idstringRequired

Unique id

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

namestringRequired

offload_ip_filteringbooleanRequired

tagsstring[]Optional

targetstringRequired

thresholdintegerRequired

timeframeintegerRequired

ttlintegerRequired

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get/api/v4.3/conf/{config}/dynamic-rules/{entry_id}

GET /api/v4.3/conf/{config}/dynamic-rules/{entry_id} HTTP/1.1
Accept: */*

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

Modify Dynamic Rule

put

Update an individual Dynamic Rule within a configuration

Path parameters

configstringRequired

entry_idstringRequired

Body

actionstringRequired

activebooleanRequired

descriptionstringOptionalDefault: ""

idstringRequired

Unique id

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

namestringRequired

offload_ip_filteringbooleanRequired

tagsstring[]Optional

targetstringRequired

thresholdintegerRequired

timeframeintegerRequired

ttlintegerRequired

Responses

200

Dynamic Rule updated successfully

application/json

messagestringRequired

Information about successful update operation

Example: Successfully updated entry

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

put/api/v4.3/conf/{config}/dynamic-rules/{entry_id}

PUT /api/v4.3/conf/{config}/dynamic-rules/{entry_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 258

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

{
  "message": "Successfully updated entry"
}

Create Dynamic Rule

post

Create an individual Dynamic Rule within a configuration

Path parameters

configstringRequired

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

Body

actionstringRequired

activebooleanRequired

descriptionstringOptionalDefault: ""

idstringRequired

Unique id

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

namestringRequired

offload_ip_filteringbooleanRequired

tagsstring[]Optional

targetstringRequired

thresholdintegerRequired

timeframeintegerRequired

ttlintegerRequired

Responses

201

Dynamic Rule created successfully

application/json

messagestringRequired

Information about successful create operation

Example: Successfully created entry

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post/api/v4.3/conf/{config}/dynamic-rules/{entry_id}

POST /api/v4.3/conf/{config}/dynamic-rules/{entry_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 258

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

{
  "message": "Successfully created entry"
}

Delete Dynamic Rule

delete

Delete an individual Dynamic Rule from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Dynamic Rule deleted successfully

application/json

messagestringRequired

Information about successful delete operation

Example: Successfully deleted entry

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

delete/api/v4.3/conf/{config}/dynamic-rules/{entry_id}

DELETE /api/v4.3/conf/{config}/dynamic-rules/{entry_id} HTTP/1.1
Accept: */*

{
  "message": "Successfully deleted entry"
}