Dynamic Rules

Get Dynamic Rules

get

Get all Dynamic Rules in a configuration

Path parameters

configstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

500

200

{
  "total": 1,
  "items": [
    {
      "action": "text",
      "active": true,
      "description": "text",
      "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
    }
  ]
}

Dynamic Rules retrieved successfully

Get specific Dynamic Rule

get

Get a Dynamic Rule from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

422

500

200

{
  "action": "text",
  "active": true,
  "description": "text",
  "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
}

Dynamic Rule retrieved successfully

Modify Dynamic Rule

put

Update an individual Dynamic Rule within a configuration

Path parameters

configstringrequired

entry_idstringrequired

Body

actionstringrequired

activebooleanrequired

descriptionstring · default: ""optional

idstringrequired

Unique id

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

includeobjectoptional

excludeobjectoptional

namestringrequired

offload_ip_filteringbooleanrequired

tagsstring[]optional

targetstringrequired

thresholdintegerrequired

timeframeintegerrequired

ttlintegerrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/dynamic-rules/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "action": "text",
    "active": true,
    "description": "text",
    "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
  }'

200

400

422

500

200

{
  "message": "Successfully updated entry"
}

Dynamic Rule updated successfully

Create Dynamic Rule

post

Create an individual Dynamic Rule within a configuration

Path parameters

configstringrequired

entry_idstringrequired

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

Body

actionstringrequired

activebooleanrequired

descriptionstring · default: ""optional

idstringrequired

Unique id

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

includeobjectoptional

excludeobjectoptional

namestringrequired

offload_ip_filteringbooleanrequired

tagsstring[]optional

targetstringrequired

thresholdintegerrequired

timeframeintegerrequired

ttlintegerrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/dynamic-rules/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "action": "text",
    "active": true,
    "description": "text",
    "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
  }'

201

400

422

500

201

{
  "message": "Successfully created entry"
}

Dynamic Rule created successfully

Delete Dynamic Rule

delete

Delete an individual Dynamic Rule from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

422

500

200

{
  "message": "Successfully deleted entry"
}

Dynamic Rule deleted successfully