Dynamic Rules

PreviousData queries NextEdge Functions

Last updated 2 months ago

Was this helpful?

Get Dynamic Rules

Get all Dynamic Rules in a configuration

get

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

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

500

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

Dynamic Rules retrieved successfully

Get specific Dynamic Rule

Get a Dynamic Rule from the specified configuration

get

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

Path parameters

configConfigrequired

entry_idEntry IDrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

422

500

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

Dynamic Rule retrieved successfully

Modify Dynamic Rule

Update an individual Dynamic Rule within a configuration

put

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

Path parameters

configConfigrequired

entry_idIdrequired

Body

actionActionrequired

activeActiverequired

descriptionDescription

idIdrequired

Unique id

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

nameNamerequired

offload_ip_filteringOffloadIPFilteringrequired

targetTargetrequired

thresholdThresholdrequired

timeframeTimeframerequired

ttlTtlrequired

tagsTags

includeInclude

excludeExclude

Responses

application/json

cURL

JavaScript

Python

HTTP

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":"","id":"text","name":"text","offload_ip_filtering":true,"target":"text","threshold":1,"timeframe":1,"ttl":1,"tags":[null],"include":{"relation":"OR","tags":["text"]},"exclude":{"relation":"OR","tags":["text"]}}'

200

400

422

500

{
  "message": "Successfully updated entry"
}

Dynamic Rule updated successfully

Create Dynamic Rule

Create an individual Dynamic Rule within a configuration

post

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

Path parameters

configConfigrequired

entry_idIdrequired

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

Body

actionActionrequired

activeActiverequired

descriptionDescription

idIdrequired

Unique id

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

nameNamerequired

offload_ip_filteringOffloadIPFilteringrequired

targetTargetrequired

thresholdThresholdrequired

timeframeTimeframerequired

ttlTtlrequired

tagsTags

includeInclude

excludeExclude

Responses

application/json

cURL

JavaScript

Python

HTTP

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":"","id":"text","name":"text","offload_ip_filtering":true,"target":"text","threshold":1,"timeframe":1,"ttl":1,"tags":[null],"include":{"relation":"OR","tags":["text"]},"exclude":{"relation":"OR","tags":["text"]}}'

201

400

422

500

{
  "message": "Successfully created entry"
}

Dynamic Rule created successfully

Delete Dynamic Rule

Delete an individual Dynamic Rule from the specified configuration

delete

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

Path parameters

configConfigrequired

entry_idIdrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

422

500

{
  "message": "Successfully deleted entry"
}

Dynamic Rule deleted successfully