Global Filters

Get Global Filters

get

Get all Global Filters in a configuration

Path parameters
configstringRequired
Responses
200
Global Filters retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/global-filters HTTP/1.1
Host: 
Accept: */*
200

Global Filters retrieved successfully

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

Modify Global Filters

put

Update an existing set of Global Filters for a configuration

Path parameters
configstringRequired
Bodyobject · GlobalFilter[]
actionanyOptional
activebooleanRequired
descriptionstringOptional
idstringRequired
mdatestringRequired
namestringRequired
ruleany ofOptionalDefault: {}
anyOptional
or
sourcestringRequired
tagsstring[]Optional
Responses
200
Global Filters updated successfully
application/json
put
PUT /api/v4.0/conf/{config}/global-filters HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 137

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

Create Global Filters

post

Create a complete set of Global Filters for a configuration

Path parameters
configstringRequired
Bodyobject · GlobalFilter[]
actionanyOptional
activebooleanRequired
descriptionstringOptional
idstringRequired
mdatestringRequired
namestringRequired
ruleany ofOptionalDefault: {}
anyOptional
or
sourcestringRequired
tagsstring[]Optional
Responses
201
Global Filters created successfully
application/json
post
POST /api/v4.0/conf/{config}/global-filters HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 137

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

Delete Global Filters

delete

Delete all Global Filters in a configuration

Path parameters
configstringRequired
Responses
200
Global Filters deleted successfully
application/json
delete
DELETE /api/v4.0/conf/{config}/global-filters HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get specific Global Filter

get

Get a Global Filter from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Global Filter retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/global-filters/{entry_id} HTTP/1.1
Host: 
Accept: */*

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

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 ofOptionalDefault: {}
anyOptional
or
sourcestringRequired
tagsstring[]Optional
Responses
200
Global Filter updated successfully
application/json
put
PUT /api/v4.0/conf/{config}/global-filters/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 135

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

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 ofOptionalDefault: {}
anyOptional
or
sourcestringRequired
tagsstring[]Optional
Responses
201
Global Filter created successfully
application/json
post
POST /api/v4.0/conf/{config}/global-filters/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 135

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

Delete single Global Filter

delete

Delete an individual Global Filter from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Global Filter deleted successfully
application/json
delete
DELETE /api/v4.0/conf/{config}/global-filters/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get Global Filters version list

get

Get list of versions of Global Filters in a configuration

Path parameters
configstringRequired
Responses
200
Global Filters version list retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/global-filters/versions HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[email protected]",
      "message": "text",
      "date": "2025-07-06T20:53:48.303Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Global Filter

get

Get a specific version of a Global Filter

Path parameters
configstringRequired
versionstringRequired
Responses
200
Global Filter retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/global-filters/versions/{version} HTTP/1.1
Host: 
Accept: */*

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

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
200
Global Filter reversion was successful
application/json
put
PUT /api/v4.0/conf/{config}/global-filters/versions/{version}/revert HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully updated entry"
}
PreviousFlow Control PoliciesNextLoad Balancers

Last updated

Was this helpful?