Flow Control Policies

Get Flow Control Policies

Get all Flow Control Policies in a configuration

GET/api/v4.0/conf/{config}/flow-control-policies

Path parameters

config*Config

Response

200

Flow Control Policies retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of FlowControl

Request

JavaScriptCurlPython

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

Response

200

{
  "total": 1,
  "items": [
    {
      "active": false,
      "description": "text",
      "exclude": [
        "text"
      ],
      "id": "text",
      "include": [
        "text"
      ],
      "key": [
        {
          "args": "text",
          "attrs": "asnFlowSef",
          "cookies": "text",
          "headers": "text",
          "plugins": "text"
        }
      ],
      "name": "text",
      "sequence": [
        {
          "method": "GET",
          "uri": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "timeframe": 0
    }
  ]
}

Modify Flow Control Policies

Update an existing set of Flow Control Policies for a configuration

PUT/api/v4.0/conf/{config}/flow-control-policies

Path parameters

config*Config

Body

application/json

active*Active flag

This flow is active

descriptionDescription

stringnull

excludeExcluded tags

Tags describing requests to exclude from the flow control rule

id*Id

includeIncluded tags

Tags describing requests to include in the flow control rule

key*Key

name*Name

sequence*Sequence

Array of sections describing steps of restricted flow

tagsTags List

List of tags to apply

timeframe*Time To Limit

The time in which to limit the requests according to the threshold

Response

200422

Flow Control Policies updated successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "timeframe": 0,
        "key": [
          {}
        ],
        "sequence": [
          {
            "method": "GET",
            "uri": "text"
          }
        ],
        "active": false
      }
    ]),
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}

Create Flow Control Policies

Create a complete set of Flow Control Policies for a configuration

POST/api/v4.0/conf/{config}/flow-control-policies

Path parameters

config*Config

Body

application/json

active*Active flag

This flow is active

descriptionDescription

stringnull

excludeExcluded tags

Tags describing requests to exclude from the flow control rule

id*Id

includeIncluded tags

Tags describing requests to include in the flow control rule

key*Key

name*Name

sequence*Sequence

Array of sections describing steps of restricted flow

tagsTags List

List of tags to apply

timeframe*Time To Limit

The time in which to limit the requests according to the threshold

Response

201422

Flow Control Policies created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "timeframe": 0,
        "key": [
          {}
        ],
        "sequence": [
          {
            "method": "GET",
            "uri": "text"
          }
        ],
        "active": false
      }
    ]),
});
const data = await response.json();

Response

201422

{
  "message": "Successfully created entry"
}

Delete Flow Control Policies

Delete all Flow Control Policies in a configuration

DELETE/api/v4.0/conf/{config}/flow-control-policies

Path parameters

config*Config

Response

200422

Flow Control Policies deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

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

Response

200422

{
  "message": "Successfully deleted entry"
}

Get specific Flow Control Policy

Get a Flow Control Policy from the specified configuration

GET/api/v4.0/conf/{config}/flow-control-policies/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

200422

Flow Control Policy retrieved successfully

Body

application/json

active*Active flag

This flow is active

descriptionDescription

stringnull

excludeExcluded tags

Tags describing requests to exclude from the flow control rule

id*Id

includeIncluded tags

Tags describing requests to include in the flow control rule

key*Key

name*Name

sequence*Sequence

Array of sections describing steps of restricted flow

tagsTags List

List of tags to apply

timeframe*Time To Limit

The time in which to limit the requests according to the threshold

Request

JavaScriptCurlPython

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

Response

200422

{
  "active": false,
  "description": "text",
  "exclude": [
    "text"
  ],
  "id": "text",
  "include": [
    "text"
  ],
  "key": [
    {
      "args": "text",
      "attrs": "asnFlowSef",
      "cookies": "text",
      "headers": "text",
      "plugins": "text"
    }
  ],
  "name": "text",
  "sequence": [
    {
      "method": "GET",
      "uri": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "timeframe": 0
}

Modify a single Flow Control Policy

Update an individual Flow Control Policy within a configuration

PUT/api/v4.0/conf/{config}/flow-control-policies/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

application/json

active*Active flag

This flow is active

descriptionDescription

stringnull

excludeExcluded tags

Tags describing requests to exclude from the flow control rule

id*Id

includeIncluded tags

Tags describing requests to include in the flow control rule

key*Key

name*Name

sequence*Sequence

Array of sections describing steps of restricted flow

tagsTags List

List of tags to apply

timeframe*Time To Limit

The time in which to limit the requests according to the threshold

Response

200422

Flow Control Policy updated successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "timeframe": 0,
      "key": [
        {}
      ],
      "sequence": [
        {
          "method": "GET",
          "uri": "text"
        }
      ],
      "active": false
    }),
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}

Create single Flow Control Policy

Create an individual Flow Control Policy within a configuration

POST/api/v4.0/conf/{config}/flow-control-policies/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

application/json

active*Active flag

This flow is active

descriptionDescription

stringnull

excludeExcluded tags

Tags describing requests to exclude from the flow control rule

id*Id

includeIncluded tags

Tags describing requests to include in the flow control rule

key*Key

name*Name

sequence*Sequence

Array of sections describing steps of restricted flow

tagsTags List

List of tags to apply

timeframe*Time To Limit

The time in which to limit the requests according to the threshold

Response

201422

Flow Control Policy created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/flow-control-policies/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "timeframe": 0,
      "key": [
        {}
      ],
      "sequence": [
        {
          "method": "GET",
          "uri": "text"
        }
      ],
      "active": false
    }),
});
const data = await response.json();

Response

201422

{
  "message": "Successfully created entry"
}

Delete single Flow Control Policy

Delete an individual Flow Control Policy from the specified configuration

DELETE/api/v4.0/conf/{config}/flow-control-policies/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

200422

Flow Control Policy deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

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

Response

200422

{
  "message": "Successfully deleted entry"
}

Get Flow Control Policies version list

Get list of versions of Flow Control Policies in a configuration

GET/api/v4.0/conf/{config}/flow-control-policies/versions

Path parameters

config*Config

Response

200422

Flow Control Policies version list retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of VersionEntry

Request

JavaScriptCurlPython

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

Response

200422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[e-mail]",
      "message": "text",
      "date": "2024-09-19T01:08:50.218Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Flow Control Policy

Get a specific version of a Flow Control Policy

GET/api/v4.0/conf/{config}/flow-control-policies/versions/{version}

Path parameters

config*Config

version*Version

Response

200422

Flow Control Policy retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of FlowControl

Request

JavaScriptCurlPython

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

Response

200422

{
  "total": 1,
  "items": [
    {
      "active": false,
      "description": "text",
      "exclude": [
        "text"
      ],
      "id": "text",
      "include": [
        "text"
      ],
      "key": [
        {
          "args": "text",
          "attrs": "asnFlowSef",
          "cookies": "text",
          "headers": "text",
          "plugins": "text"
        }
      ],
      "name": "text",
      "sequence": [
        {
          "method": "GET",
          "uri": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "timeframe": 0
    }
  ]
}

Revert a Flow Control Policy to the specified version

Set a previous Flow Control Policy version to be the current one

PUT/api/v4.0/conf/{config}/flow-control-policies/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

200422

Flow Control Policy reversion was successful

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

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

Response

200422

{
  "message": "Successfully updated entry"
}