Dynamic Rules

Get Dynamic Rules

get

Get all Dynamic Rules in a configuration

Path parameters
configstringRequired
Responses
200
Dynamic Rules retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/dynamic-rules HTTP/1.1
Host: 
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
get
GET /api/v4.0/conf/{config}/dynamic-rules/{entry_id} HTTP/1.1
Host: 
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
put
PUT /api/v4.0/conf/{config}/dynamic-rules/{entry_id} HTTP/1.1
Host: 
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
post
POST /api/v4.0/conf/{config}/dynamic-rules/{entry_id} HTTP/1.1
Host: 
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
delete
DELETE /api/v4.0/conf/{config}/dynamic-rules/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

PreviousData queriesNextEdge Functions

Last updated

Was this helpful?