Flow Control Policies

PreviousEdge Functions NextGlobal Filters

Last updated 16 days ago

Was this helpful?

Get Flow Control Policies

Get all Flow Control Policies in a configuration

get

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

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/flow-control-policies'

200

{
  "total": 1,
  "items": [
    {
      "active": true,
      "id": "text",
      "name": "text",
      "timeframe": 1,
      "exclude": [],
      "include": [],
      "key": [],
      "steps": [],
      "tags": [],
      "description": ""
    }
  ]
}

Flow Control Policies retrieved successfully

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

configConfigrequired

Body

activeActive flagrequired

This flow is active

idIdrequired

nameNamerequired

timeframeTime To Limitrequired

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

excludeExcluded tags

Tags describing requests to exclude from the flow control rule

includeIncluded tags

Tags describing requests to include in the flow control rule

keyKeyrequired

stepsStepsrequired

Array of sections describing steps of restricted flow

tagsTags List

List of tags to apply

descriptionDescription

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/flow-control-policies' \
  --header 'Content-Type: application/json' \
  --data '[{"active":true,"id":"text","name":"text","timeframe":1,"exclude":[],"include":[],"key":[],"steps":[],"tags":[],"description":""}]'

200

422

{
  "message": "Successfully updated entry"
}

Flow Control Policies updated successfully

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

configConfigrequired

Body

activeActive flagrequired

This flow is active

idIdrequired

nameNamerequired

timeframeTime To Limitrequired

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

excludeExcluded tags

Tags describing requests to exclude from the flow control rule

includeIncluded tags

Tags describing requests to include in the flow control rule

keyKeyrequired

stepsStepsrequired

Array of sections describing steps of restricted flow

tagsTags List

List of tags to apply

descriptionDescription

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/flow-control-policies' \
  --header 'Content-Type: application/json' \
  --data '[{"active":true,"id":"text","name":"text","timeframe":1,"exclude":[],"include":[],"key":[],"steps":[],"tags":[],"description":""}]'

201

422

{
  "message": "Successfully created entry"
}

Flow Control Policies created successfully

Delete Flow Control Policies

Delete all Flow Control Policies in a configuration

delete

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

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/flow-control-policies'

200

422

{
  "message": "Successfully deleted entry"
}

Flow Control Policies deleted successfully

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

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/flow-control-policies/{entry_id}'

200

422

{
  "active": true,
  "id": "text",
  "name": "text",
  "timeframe": 1,
  "exclude": [],
  "include": [],
  "key": [],
  "steps": [],
  "tags": [],
  "description": ""
}

Flow Control Policy retrieved successfully

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

configConfigrequired

entry_idEntryrequired

Body

activeActive flagrequired

This flow is active

idIdrequired

nameNamerequired

timeframeTime To Limitrequired

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

excludeExcluded tags

Tags describing requests to exclude from the flow control rule

includeIncluded tags

Tags describing requests to include in the flow control rule

keyKeyrequired

stepsStepsrequired

Array of sections describing steps of restricted flow

tagsTags List

List of tags to apply

descriptionDescription

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/flow-control-policies/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"active":true,"id":"text","name":"text","timeframe":1,"exclude":[],"include":[],"key":[],"steps":[],"tags":[],"description":""}'

200

422

{
  "message": "Successfully updated entry"
}

Flow Control Policy updated successfully

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

configConfigrequired

entry_idEntryrequired

Body

activeActive flagrequired

This flow is active

idIdrequired

nameNamerequired

timeframeTime To Limitrequired

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

excludeExcluded tags

Tags describing requests to exclude from the flow control rule

includeIncluded tags

Tags describing requests to include in the flow control rule

keyKeyrequired

stepsStepsrequired

Array of sections describing steps of restricted flow

tagsTags List

List of tags to apply

descriptionDescription

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/flow-control-policies/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"active":true,"id":"text","name":"text","timeframe":1,"exclude":[],"include":[],"key":[],"steps":[],"tags":[],"description":""}'

201

422

{
  "message": "Successfully created entry"
}

Flow Control Policy created successfully

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

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/flow-control-policies/{entry_id}'

200

422

{
  "message": "Successfully deleted entry"
}

Flow Control Policy deleted successfully

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

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/flow-control-policies/versions'

200

422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "hello@example.com",
      "message": "text",
      "date": "2025-02-21T18:20:42.543Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Flow Control Policies version list retrieved successfully

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

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/flow-control-policies/versions/{version}'

200

422

{
  "total": 1,
  "items": [
    {
      "active": true,
      "id": "text",
      "name": "text",
      "timeframe": 1,
      "exclude": [],
      "include": [],
      "key": [],
      "steps": [],
      "tags": [],
      "description": ""
    }
  ]
}

Flow Control Policy retrieved successfully

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

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/flow-control-policies/versions/{version}/revert'

200

422

{
  "message": "Successfully updated entry"
}

Flow Control Policy reversion was successful