Flow Control Policies

PreviousEdge Functions NextGlobal Filters

Last updated 2 months ago

Was this helpful?

Delete Flow Control Policies

delete

Delete all Flow Control Policies in a configuration

Path parameters

configstringRequired

Responses

200

Flow Control Policies deleted successfully

application/json

422

Validation Error

application/json

delete

DELETE /api/v4.0/conf/{config}/flow-control-policies HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get specific Flow Control Policy

get

Get a Flow Control Policy from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Flow Control Policy retrieved successfully

application/json

422

Validation Error

application/json

get

GET /api/v4.0/conf/{config}/flow-control-policies/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "active": true,
  "description": "text",
  "exclude": [
    "text"
  ],
  "id": "text",
  "include": [
    "text"
  ],
  "key": [
    {
      "args": "text",
      "attrs": "asnFlowSef",
      "cookies": "text",
      "headers": "text",
      "plugins": "text"
    }
  ],
  "name": "text",
  "steps": [
    {
      "args": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "cookies": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "method": "GET",
      "plugins": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "uri": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "timeframe": 1
}

Delete single Flow Control Policy

delete

Delete an individual Flow Control Policy from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Flow Control Policy deleted successfully

application/json

422

Validation Error

application/json

delete

DELETE /api/v4.0/conf/{config}/flow-control-policies/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get Flow Control Policies version list

get

Get list of versions of Flow Control Policies in a configuration

Path parameters

configstringRequired

Responses

200

Flow Control Policies version list retrieved successfully

application/json

422

Validation Error

application/json

get

GET /api/v4.0/conf/{config}/flow-control-policies/versions HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2025-05-03T17:06:55.767Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Flow Control Policy

get

Get a specific version of a Flow Control Policy

Path parameters

configstringRequired

versionstringRequired

Responses

200

Flow Control Policy retrieved successfully

application/json

422

Validation Error

application/json

get

GET /api/v4.0/conf/{config}/flow-control-policies/versions/{version} HTTP/1.1
Host: 
Accept: */*

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

Revert a Flow Control Policy to the specified version

put

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

Path parameters

configstringRequired

versionstringRequired

Responses

200

Flow Control Policy reversion was successful

application/json

422

Validation Error

application/json

put

PUT /api/v4.0/conf/{config}/flow-control-policies/versions/{version}/revert HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully updated entry"
}

Get Flow Control Policies

get

Get all Flow Control Policies in a configuration

Path parameters

configstringRequired

Responses

200

Flow Control Policies retrieved successfully

application/json

get

GET /api/v4.0/conf/{config}/flow-control-policies HTTP/1.1
Host: 
Accept: */*

200

Flow Control Policies retrieved successfully

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

Modify Flow Control Policies

put

Update an existing set of Flow Control Policies for a configuration

Path parameters

configstringRequired

Body

activebooleanRequired

This flow is active

descriptionany ofOptionalDefault: ""

stringOptional

nullOptional

excludestring[]Optional

Tags describing requests to exclude from the flow control rule

Default: []

idstringRequired

includestring[]Optional

Tags describing requests to include in the flow control rule

Default: []

namestring · min: 1Required

tagsstring[]Optional

List of tags to apply

Default: []

timeframenumberRequired

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

Responses

200

Flow Control Policies updated successfully

application/json

422

Validation Error

application/json

put

PUT /api/v4.0/conf/{config}/flow-control-policies HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 445

[
  {
    "active": true,
    "description": "text",
    "exclude": [
      "text"
    ],
    "id": "text",
    "include": [
      "text"
    ],
    "key": [
      {
        "args": "text",
        "attrs": "asnFlowSef",
        "cookies": "text",
        "headers": "text",
        "plugins": "text"
      }
    ],
    "name": "text",
    "steps": [
      {
        "args": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "cookies": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "method": "GET",
        "plugins": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "uri": "text"
      }
    ],
    "tags": [
      "text"
    ],
    "timeframe": 1
  }
]

{
  "message": "Successfully updated entry"
}

Create Flow Control Policies

post

Create a complete set of Flow Control Policies for a configuration

Path parameters

configstringRequired

Body

activebooleanRequired

This flow is active

descriptionany ofOptionalDefault: ""

stringOptional

nullOptional

excludestring[]Optional

Tags describing requests to exclude from the flow control rule

Default: []

idstringRequired

includestring[]Optional

Tags describing requests to include in the flow control rule

Default: []

namestring · min: 1Required

tagsstring[]Optional

List of tags to apply

Default: []

timeframenumberRequired

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

Responses

201

Flow Control Policies created successfully

application/json

422

Validation Error

application/json

post

POST /api/v4.0/conf/{config}/flow-control-policies HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 445

[
  {
    "active": true,
    "description": "text",
    "exclude": [
      "text"
    ],
    "id": "text",
    "include": [
      "text"
    ],
    "key": [
      {
        "args": "text",
        "attrs": "asnFlowSef",
        "cookies": "text",
        "headers": "text",
        "plugins": "text"
      }
    ],
    "name": "text",
    "steps": [
      {
        "args": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "cookies": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "method": "GET",
        "plugins": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "uri": "text"
      }
    ],
    "tags": [
      "text"
    ],
    "timeframe": 1
  }
]

{
  "message": "Successfully created entry"
}

Modify a single Flow Control Policy

put

Update an individual Flow Control Policy within a configuration

Path parameters

configstringRequired

entry_idstringRequired

Body

activebooleanRequired

This flow is active

descriptionany ofOptionalDefault: ""

stringOptional

nullOptional

excludestring[]Optional

Tags describing requests to exclude from the flow control rule

Default: []

idstringRequired

includestring[]Optional

Tags describing requests to include in the flow control rule

Default: []

namestring · min: 1Required

tagsstring[]Optional

List of tags to apply

Default: []

timeframenumberRequired

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

Responses

200

Flow Control Policy updated successfully

application/json

422

Validation Error

application/json

put

PUT /api/v4.0/conf/{config}/flow-control-policies/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 443

{
  "active": true,
  "description": "text",
  "exclude": [
    "text"
  ],
  "id": "text",
  "include": [
    "text"
  ],
  "key": [
    {
      "args": "text",
      "attrs": "asnFlowSef",
      "cookies": "text",
      "headers": "text",
      "plugins": "text"
    }
  ],
  "name": "text",
  "steps": [
    {
      "args": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "cookies": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "method": "GET",
      "plugins": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "uri": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "timeframe": 1
}

{
  "message": "Successfully updated entry"
}

Create single Flow Control Policy

post

Create an individual Flow Control Policy within a configuration

Path parameters

configstringRequired

entry_idstringRequired

Body

activebooleanRequired

This flow is active

descriptionany ofOptionalDefault: ""

stringOptional

nullOptional

excludestring[]Optional

Tags describing requests to exclude from the flow control rule

Default: []

idstringRequired

includestring[]Optional

Tags describing requests to include in the flow control rule

Default: []

namestring · min: 1Required

tagsstring[]Optional

List of tags to apply

Default: []

timeframenumberRequired

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

Responses

201

Flow Control Policy created successfully

application/json

422

Validation Error

application/json

post

POST /api/v4.0/conf/{config}/flow-control-policies/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 443

{
  "active": true,
  "description": "text",
  "exclude": [
    "text"
  ],
  "id": "text",
  "include": [
    "text"
  ],
  "key": [
    {
      "args": "text",
      "attrs": "asnFlowSef",
      "cookies": "text",
      "headers": "text",
      "plugins": "text"
    }
  ],
  "name": "text",
  "steps": [
    {
      "args": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "cookies": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "method": "GET",
      "plugins": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "uri": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "timeframe": 1
}

{
  "message": "Successfully created entry"
}