Global Filters

PreviousFlow Control Policies NextLoad Balancers

Last updated 5 months ago

Was this helpful?

Get Global Filters

Get all Global Filters in a configuration

get

/api/v4.0/conf/{config}/global-filters

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/global-filters'

200

{
  "total": 1,
  "items": [
    {
      "action": null,
      "active": true,
      "description": "text",
      "id": "text",
      "mdate": "text",
      "name": "text",
      "source": "text",
      "tags": [
        "text"
      ],
      "rule": {}
    }
  ]
}

Global Filters retrieved successfully

Modify Global Filters

Update an existing set of Global Filters for a configuration

put

/api/v4.0/conf/{config}/global-filters

Path parameters

configConfigrequired

Body

actionAction

activeActiverequired

descriptionDescription

idIdrequired

mdateMdaterequired

nameNamerequired

sourceSourcerequired

tagsTags

ruleRule

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/global-filters' \
  --header 'Content-Type: application/json' \
  --data '[{"active":true,"id":"text","mdate":"text","name":"text","source":"text","tags":[null],"rule":{}}]'

200

422

{
  "message": "Successfully updated entry"
}

Global Filters updated successfully

Create Global Filters

Create a complete set of Global Filters for a configuration

post

/api/v4.0/conf/{config}/global-filters

Path parameters

configConfigrequired

Body

actionAction

activeActiverequired

descriptionDescription

idIdrequired

mdateMdaterequired

nameNamerequired

sourceSourcerequired

tagsTags

ruleRule

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/global-filters' \
  --header 'Content-Type: application/json' \
  --data '[{"active":true,"id":"text","mdate":"text","name":"text","source":"text","tags":[null],"rule":{}}]'

201

422

{
  "message": "Successfully created entry"
}

Global Filters created successfully

Delete Global Filters

Delete all Global Filters in a configuration

delete

/api/v4.0/conf/{config}/global-filters

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/global-filters'

200

422

{
  "message": "Successfully deleted entry"
}

Global Filters deleted successfully

Get specific Global Filter

Get a Global Filter from the specified configuration

get

/api/v4.0/conf/{config}/global-filters/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "action": null,
  "active": true,
  "description": "text",
  "id": "text",
  "mdate": "text",
  "name": "text",
  "source": "text",
  "tags": [
    "text"
  ],
  "rule": {}
}

Global Filter retrieved successfully

Modify a single Global Filter

Update an individual Global Filter within a configuration

put

/api/v4.0/conf/{config}/global-filters/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Body

actionAction

activeActiverequired

descriptionDescription

idIdrequired

mdateMdaterequired

nameNamerequired

sourceSourcerequired

tagsTags

ruleRule

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/global-filters/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"active":true,"id":"text","mdate":"text","name":"text","source":"text","tags":[null],"rule":{}}'

200

422

{
  "message": "Successfully updated entry"
}

Global Filter updated successfully

Create single Global Filter

Create an individual Global Filter within a configuration

post

/api/v4.0/conf/{config}/global-filters/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Body

actionAction

activeActiverequired

descriptionDescription

idIdrequired

mdateMdaterequired

nameNamerequired

sourceSourcerequired

tagsTags

ruleRule

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/global-filters/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"active":true,"id":"text","mdate":"text","name":"text","source":"text","tags":[null],"rule":{}}'

201

422

{
  "message": "Successfully created entry"
}

Global Filter created successfully

Delete single Global Filter

Delete an individual Global Filter from the specified configuration

delete

/api/v4.0/conf/{config}/global-filters/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "message": "Successfully deleted entry"
}

Global Filter deleted successfully

Get Global Filters version list

Get list of versions of Global Filters in a configuration

get

/api/v4.0/conf/{config}/global-filters/versions

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/global-filters/versions'

200

422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "hello@example.com",
      "message": "text",
      "date": "2025-02-21T18:02:51.169Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Global Filters version list retrieved successfully

Get version of Global Filter

Get a specific version of a Global Filter

get

/api/v4.0/conf/{config}/global-filters/versions/{version}

Path parameters

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/global-filters/versions/{version}'

200

422

{
  "total": 1,
  "items": [
    {
      "action": null,
      "active": true,
      "description": "text",
      "id": "text",
      "mdate": "text",
      "name": "text",
      "source": "text",
      "tags": [
        "text"
      ],
      "rule": {}
    }
  ]
}

Global Filter retrieved successfully

Revert a Global Filter to the specified version

Set a previous Global Filter version to be the current one

put

/api/v4.0/conf/{config}/global-filters/versions/{version}/revert

Path parameters

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/global-filters/versions/{version}/revert'

200

422

{
  "message": "Successfully updated entry"
}

Global Filter reversion was successful