Global Filters

PreviousFlow Control Policies NextLoad Balancers

Last updated 6 months ago

Was this helpful?

Delete Global Filters

delete

Delete all Global Filters in a configuration

Path parameters

configstringrequired

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

Get a Global Filter from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

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",
  "rule": null,
  "source": "text",
  "tags": [
    "text"
  ]
}

Global Filter retrieved successfully

Delete single Global Filter

delete

Delete an individual Global Filter from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

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

Get list of versions of Global Filters in a configuration

Path parameters

configstringrequired

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": "name@gmail.com",
      "message": "text",
      "date": "2025-04-03T05:51:56.729Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Global Filters version list retrieved successfully

Get version of Global Filter

get

Get a specific version of a Global Filter

Path parameters

configstringrequired

versionstringrequired

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",
      "rule": null,
      "source": "text",
      "tags": [
        "text"
      ]
    }
  ]
}

Global Filter retrieved successfully

Revert a Global Filter to the specified version

put

Set a previous Global Filter version to be the current one

Path parameters

configstringrequired

versionstringrequired

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

Get Global Filters

get

Get all Global Filters in a configuration

Path parameters

configstringrequired

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",
      "rule": null,
      "source": "text",
      "tags": [
        "text"
      ]
    }
  ]
}

Global Filters retrieved successfully

Modify Global Filters

put

Update an existing set of Global Filters for a configuration

Path parameters

configstringrequired

Body

actionanyoptional

activebooleanrequired

descriptionstringoptional

idstringrequired

mdatestringrequired

namestringrequired

ruleany of · default: {}optional

sourcestringrequired

tagsstring[]optional

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 '[
    {
      "action": null,
      "active": true,
      "description": "text",
      "id": "text",
      "mdate": "text",
      "name": "text",
      "rule": null,
      "source": "text",
      "tags": [
        "text"
      ]
    }
  ]'

200

422

{
  "message": "Successfully updated entry"
}

Global Filters updated successfully

Create Global Filters

post

Create a complete set of Global Filters for a configuration

Path parameters

configstringrequired

Body

actionanyoptional

activebooleanrequired

descriptionstringoptional

idstringrequired

mdatestringrequired

namestringrequired

ruleany of · default: {}optional

sourcestringrequired

tagsstring[]optional

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 '[
    {
      "action": null,
      "active": true,
      "description": "text",
      "id": "text",
      "mdate": "text",
      "name": "text",
      "rule": null,
      "source": "text",
      "tags": [
        "text"
      ]
    }
  ]'

201

422

{
  "message": "Successfully created entry"
}

Global Filters created successfully

Modify a single Global Filter

put

Update an individual Global Filter within a configuration

Path parameters

configstringrequired

entry_idstringrequired

Body

actionanyoptional

activebooleanrequired

descriptionstringoptional

idstringrequired

mdatestringrequired

namestringrequired

ruleany of · default: {}optional

sourcestringrequired

tagsstring[]optional

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 '{
    "action": null,
    "active": true,
    "description": "text",
    "id": "text",
    "mdate": "text",
    "name": "text",
    "rule": null,
    "source": "text",
    "tags": [
      "text"
    ]
  }'

200

422

{
  "message": "Successfully updated entry"
}

Global Filter updated successfully

Create single Global Filter

post

Create an individual Global Filter within a configuration

Path parameters

configstringrequired

entry_idstringrequired

Body

actionanyoptional

activebooleanrequired

descriptionstringoptional

idstringrequired

mdatestringrequired

namestringrequired

ruleany of · default: {}optional

sourcestringrequired

tagsstring[]optional

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 '{
    "action": null,
    "active": true,
    "description": "text",
    "id": "text",
    "mdate": "text",
    "name": "text",
    "rule": null,
    "source": "text",
    "tags": [
      "text"
    ]
  }'

201

422

{
  "message": "Successfully created entry"
}

Global Filter created successfully

Delete Global Filters

Get specific Global Filter

Delete single Global Filter

Get Global Filters version list

Get version of Global Filter

Revert a Global Filter to the specified version

Get Global Filters

Modify Global Filters

Show child attributes

Show any

Create Global Filters

Show child attributes

Show any

Modify a single Global Filter

Show child attributes

Show any

Create single Global Filter

Show child attributes

Show any