Link11 WAAP
v5
v5
  • Link11 WAAP Documentation
  • Release Notes
  • Known Issues
  • User Guide
    • Introduction to Link11 WAAP
  • How Link11 WAAP Works
    • Traffic Filtering Process
    • Traffic Reporting and Analytics
    • Policy Mapping and Traffic Routing
    • Tagging
    • UI Overview and Common Elements
  • Console UI Walkthrough
    • Analytics
      • Dashboard
      • Events Log
    • Security
      • Global Filters
      • Flow Control Policies
      • Security Policies
      • Rate Limit Rules
      • ACL Profiles
      • Actions
      • Dynamic Rules
      • Quarantined
      • Content Filter
        • Content Filter Profiles
        • Content Filter Rules
    • Sites
      • Server Groups
      • Proxy Templates
      • Mobile Application Groups
      • Backend Services
      • Edge Functions
      • DNS Records
      • SSL
        • Load Balancers
        • Certificates
    • System
      • Interactive Challenge
      • SSO Configuration
      • Purge CDN Cache
      • Users Management
      • Security Alerts
      • Log Exporters
      • Version Control
      • System DB
      • Publish Changes
    • Account
  • Using the product
    • Best Practices
      • Saving and Publishing Your Changes
      • Enabling Passive Challenges
      • Understanding and Diagnosing Traffic Issues
    • How Do I...
      • Authenticate mobile app users
      • Ban, unban, and allowlist traffic sources
      • Bypass Link11 WAAP for loadtesting or other purposes
      • Configure a new path/section of a site
      • Control caching behavior
      • Enable GraphQL traffic
      • Enable mTLS (mutual TLS)
      • Protect sensitive information in logs and analytics
      • Quickly block an attacker
      • Redirect or block HTTP traffic
      • Run custom code
      • Set rate limits and exemptions
      • Stream event data to a SIEM solution or other destination
    • The Link11 WAAP API
      • Overview
      • Internal data structures
      • Using Swagger UI
      • Using curl
  • Reference Information
    • Acronyms
    • API
      • API access to traffic data
      • Types of namespaces
      • Namespace reference
        • ACL Profiles
        • Actions
        • Backend Services
        • Certificates
        • Configs
        • Content Filter Profiles
        • Content Filter Rules
        • Data queries
        • Dynamic Rules
        • Edge Functions
        • Flow Control Policies
        • Global Filters
        • Load Balancers
        • Log Exporters
        • Mobile Application Groups
        • Planets
        • Proxy Templates
        • Rate Limit Rules
        • Security Alerts
        • Security Policies
        • Server Groups
        • Tags
        • Tools
        • Users
    • Hostile Bot Detection / LWCSI
      • Environmental detection and browser verification
      • Client authentication
      • Biometric behavioral verification
    • HTTP Response Codes
    • Log Exporter Output
    • Pattern Matching Syntax
    • Query Filter Syntax and Best Practices
  • Support
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Reference Information
  2. API
  3. Namespace reference

Flow Control Policies

PreviousEdge FunctionsNextGlobal Filters

Last updated 3 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": "",
  "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-14T06:09:46.435Z",
      "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": "",
      "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"
}
  • GETGet Flow Control Policies
  • PUTModify Flow Control Policies
  • POSTCreate Flow Control Policies
  • DELETEDelete Flow Control Policies
  • GETGet specific Flow Control Policy
  • PUTModify a single Flow Control Policy
  • POSTCreate single Flow Control Policy
  • DELETEDelete single Flow Control Policy
  • GETGet Flow Control Policies version list
  • GETGet version of Flow Control Policy
  • PUTRevert a Flow Control Policy to the specified version

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": "",
      "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
or
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: 441

[
  {
    "active": true,
    "description": "",
    "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
or
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: 441

[
  {
    "active": true,
    "description": "",
    "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
or
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: 439

{
  "active": true,
  "description": "",
  "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
or
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: 439

{
  "active": true,
  "description": "",
  "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"
}