Global Filters

Get Global Filters

Get all Global Filters in a configuration

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

Path parameters

config*Config

Response

Global Filters retrieved successfully

Body

totalinteger

Example: 1

itemsarray of GlobalFilter

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "total": 1,
  "items": [
    {
      "active": false,
      "description": "text",
      "id": "text",
      "mdate": "text",
      "name": "text",
      "source": "text",
      "tags": [
        "text"
      ]
    }
  ]
}

Modify Global Filters

Update an existing set of Global Filters for a configuration

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

Path parameters

config*Config

Body

actionAction

active*Active

descriptionDescription

id*Id

mdate*Mdate

name*Name

ruleRule

source*Source

tagsTags

Response

Global Filters updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "source": "text",
        "mdate": "text",
        "active": false
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

Create Global Filters

Create a complete set of Global Filters for a configuration

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

Path parameters

config*Config

Body

actionAction

active*Active

descriptionDescription

id*Id

mdate*Mdate

name*Name

ruleRule

source*Source

tagsTags

Response

Global Filters created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "source": "text",
        "mdate": "text",
        "active": false
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "Successfully created entry"
}

Delete Global Filters

Delete all Global Filters in a configuration

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

Path parameters

config*Config

Response

Global Filters deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted entry"
}

Get specific Global Filter

Get a Global Filter from the specified configuration

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

Path parameters

config*Config

entry_id*Entry

Response

Global Filter retrieved successfully

Body

actionAction

active*Active

descriptionDescription

id*Id

mdate*Mdate

name*Name

ruleRule

source*Source

tagsTags

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "active": false,
  "description": "text",
  "id": "text",
  "mdate": "text",
  "name": "text",
  "source": "text",
  "tags": [
    "text"
  ]
}

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

config*Config

entry_id*Entry

Body

actionAction

active*Active

descriptionDescription

id*Id

mdate*Mdate

name*Name

ruleRule

source*Source

tagsTags

Response

Global Filter updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "source": "text",
      "mdate": "text",
      "active": false
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

Create single Global Filter

Create an individual Global Filter within a configuration

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

Path parameters

config*Config

entry_id*Entry

Body

actionAction

active*Active

descriptionDescription

id*Id

mdate*Mdate

name*Name

ruleRule

source*Source

tagsTags

Response

Global Filter created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "source": "text",
      "mdate": "text",
      "active": false
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully created entry"
}

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

config*Config

entry_id*Entry

Response

Global Filter deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted entry"
}

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

config*Config

Response

Global Filters version list retrieved successfully

Body

totalinteger

Example: 1

itemsarray of VersionEntry

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2024-09-19T01:07:50.114Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

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

config*Config

version*Version

Response

Global Filter retrieved successfully

Body

totalinteger

Example: 1

itemsarray of GlobalFilter

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "total": 1,
  "items": [
    {
      "active": false,
      "description": "text",
      "id": "text",
      "mdate": "text",
      "name": "text",
      "source": "text",
      "tags": [
        "text"
      ]
    }
  ]
}

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

config*Config

version*Version

Response

Global Filter reversion was successful

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/global-filters/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

PreviousFlow Control Policies NextLoad Balancers

Last updated 6 days ago