> For the complete documentation index, see [llms.txt](https://waap.docs.link11.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://waap.docs.link11.com/reference-information/api/namespace-reference/flow-control-policies.md).

# Flow Control Policies

## Get Flow Control Policies

> Get all Flow Control Policies in a configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/flow-control-policies":{"get":{"operationId":"document_resource_get_api_v3_configs__config__d__document___get_18696332526555447","summary":"Get Flow Control Policies","description":"Get all Flow Control Policies in a configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}}],"responses":{"200":{"description":"Flow Control Policies retrieved successfully","content":{"application/json":{"schema":{"title":"Flow Control Policies document","properties":{"total":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/FlowControl"}}}}}}}},"tags":["Flow Control Policies"]}}},"components":{"schemas":{"FlowControl":{"additionalProperties":false,"properties":{"active":{"description":"This flow is active","title":"Active flag","type":"boolean"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Description"},"exclude":{"default":[],"description":"Tags describing requests to exclude from the flow control rule","items":{"type":"string"},"title":"Excluded tags","type":"array"},"id":{"title":"Id","type":"string"},"include":{"default":[],"description":"Tags describing requests to include in the flow control rule","items":{"type":"string"},"title":"Included tags","type":"array"},"key":{"items":{"$ref":"#/components/schemas/FlowControlKeyEntry"},"title":"Key","type":"array","default":[]},"name":{"minLength":1,"title":"Name","type":"string"},"steps":{"description":"Array of sections describing steps of restricted flow","items":{"$ref":"#/components/schemas/FlowStepItem"},"title":"Steps","type":"array","default":[]},"tags":{"default":[],"description":"List of tags to apply","items":{"type":"string"},"title":"Tags List","type":"array"},"timeframe":{"description":"The time in which to limit the requests according to the threshold","title":"Time To Limit","type":"number"}},"required":["id","name","timeframe","key","steps","active"],"title":"FlowControl","type":"object"},"FlowControlKeyEntry":{"additionalProperties":false,"properties":{"args":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Arguments"},"attrs":{"anyOf":[{"$ref":"#/components/schemas/AttributesEnum"},{"type":"null"}],"default":null,"title":"Attributes"},"cookies":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Headers"},"plugins":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Plugins"}},"title":"KeyEntry","type":"object"},"AttributesEnum":{"enum":["asnFlowSef","authority","company","country","ip","method","network","path","query","region","secpolentryid","securitypolicyentryid","securitypolicyentry","secpolid","securitypolicyid","securitypolicy","secpolname","securitypolicyname","secpolentryname","securitypolicyentryname","session","subregion","tags","uri"],"title":"AttributesEnum","type":"string"},"FlowStepItem":{"properties":{"args":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Args"},"cookies":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Headers"},"method":{"$ref":"#/components/schemas/HTTPMethodEnum"},"plugins":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Plugins"},"uri":{"title":"Uri","type":"string"}},"required":["method","uri"],"title":"FlowStepItem","type":"object"},"HTTPMethodEnum":{"enum":["GET","HEAD","POST","PUT","DELETE","CONNECT","TRACE","OPTIONS","PATCH"],"title":"HTTPMethodEnum","type":"string"}}}}
```

## Modify Flow Control Policies

> Update an existing set of Flow Control Policies for a configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/flow-control-policies":{"put":{"operationId":"document_resource_put_api_v3_configs__config__d__document___put_18696332526555447","summary":"Modify Flow Control Policies","description":"Update an existing set of Flow Control Policies for a configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Flow Control Policies document","type":"array","items":{"$ref":"#/components/schemas/FlowControl"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUpdate"}}},"description":"Flow Control Policies updated successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Flow Control Policies"]}}},"components":{"schemas":{"FlowControl":{"additionalProperties":false,"properties":{"active":{"description":"This flow is active","title":"Active flag","type":"boolean"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Description"},"exclude":{"default":[],"description":"Tags describing requests to exclude from the flow control rule","items":{"type":"string"},"title":"Excluded tags","type":"array"},"id":{"title":"Id","type":"string"},"include":{"default":[],"description":"Tags describing requests to include in the flow control rule","items":{"type":"string"},"title":"Included tags","type":"array"},"key":{"items":{"$ref":"#/components/schemas/FlowControlKeyEntry"},"title":"Key","type":"array","default":[]},"name":{"minLength":1,"title":"Name","type":"string"},"steps":{"description":"Array of sections describing steps of restricted flow","items":{"$ref":"#/components/schemas/FlowStepItem"},"title":"Steps","type":"array","default":[]},"tags":{"default":[],"description":"List of tags to apply","items":{"type":"string"},"title":"Tags List","type":"array"},"timeframe":{"description":"The time in which to limit the requests according to the threshold","title":"Time To Limit","type":"number"}},"required":["id","name","timeframe","key","steps","active"],"title":"FlowControl","type":"object"},"FlowControlKeyEntry":{"additionalProperties":false,"properties":{"args":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Arguments"},"attrs":{"anyOf":[{"$ref":"#/components/schemas/AttributesEnum"},{"type":"null"}],"default":null,"title":"Attributes"},"cookies":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Headers"},"plugins":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Plugins"}},"title":"KeyEntry","type":"object"},"AttributesEnum":{"enum":["asnFlowSef","authority","company","country","ip","method","network","path","query","region","secpolentryid","securitypolicyentryid","securitypolicyentry","secpolid","securitypolicyid","securitypolicy","secpolname","securitypolicyname","secpolentryname","securitypolicyentryname","session","subregion","tags","uri"],"title":"AttributesEnum","type":"string"},"FlowStepItem":{"properties":{"args":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Args"},"cookies":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Headers"},"method":{"$ref":"#/components/schemas/HTTPMethodEnum"},"plugins":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Plugins"},"uri":{"title":"Uri","type":"string"}},"required":["method","uri"],"title":"FlowStepItem","type":"object"},"HTTPMethodEnum":{"enum":["GET","HEAD","POST","PUT","DELETE","CONNECT","TRACE","OPTIONS","PATCH"],"title":"HTTPMethodEnum","type":"string"},"ResponseUpdate":{"title":"ResponseUpdate","type":"object","properties":{"message":{"title":"Message","description":"Information about successful update operation","type":"string"}},"required":["message"]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Create Flow Control Policies

> Create a complete set of Flow Control Policies for a configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/flow-control-policies":{"post":{"operationId":"document_resource_post_api_v3_configs__config__d__document___post_18696332526555447","summary":"Create Flow Control Policies","description":"Create a complete set of Flow Control Policies for a configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"Flow Control Policies document","type":"array","items":{"$ref":"#/components/schemas/FlowControl"}}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreate"}}},"description":"Flow Control Policies created successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Flow Control Policies"]}}},"components":{"schemas":{"FlowControl":{"additionalProperties":false,"properties":{"active":{"description":"This flow is active","title":"Active flag","type":"boolean"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Description"},"exclude":{"default":[],"description":"Tags describing requests to exclude from the flow control rule","items":{"type":"string"},"title":"Excluded tags","type":"array"},"id":{"title":"Id","type":"string"},"include":{"default":[],"description":"Tags describing requests to include in the flow control rule","items":{"type":"string"},"title":"Included tags","type":"array"},"key":{"items":{"$ref":"#/components/schemas/FlowControlKeyEntry"},"title":"Key","type":"array","default":[]},"name":{"minLength":1,"title":"Name","type":"string"},"steps":{"description":"Array of sections describing steps of restricted flow","items":{"$ref":"#/components/schemas/FlowStepItem"},"title":"Steps","type":"array","default":[]},"tags":{"default":[],"description":"List of tags to apply","items":{"type":"string"},"title":"Tags List","type":"array"},"timeframe":{"description":"The time in which to limit the requests according to the threshold","title":"Time To Limit","type":"number"}},"required":["id","name","timeframe","key","steps","active"],"title":"FlowControl","type":"object"},"FlowControlKeyEntry":{"additionalProperties":false,"properties":{"args":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Arguments"},"attrs":{"anyOf":[{"$ref":"#/components/schemas/AttributesEnum"},{"type":"null"}],"default":null,"title":"Attributes"},"cookies":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Headers"},"plugins":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Plugins"}},"title":"KeyEntry","type":"object"},"AttributesEnum":{"enum":["asnFlowSef","authority","company","country","ip","method","network","path","query","region","secpolentryid","securitypolicyentryid","securitypolicyentry","secpolid","securitypolicyid","securitypolicy","secpolname","securitypolicyname","secpolentryname","securitypolicyentryname","session","subregion","tags","uri"],"title":"AttributesEnum","type":"string"},"FlowStepItem":{"properties":{"args":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Args"},"cookies":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Headers"},"method":{"$ref":"#/components/schemas/HTTPMethodEnum"},"plugins":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Plugins"},"uri":{"title":"Uri","type":"string"}},"required":["method","uri"],"title":"FlowStepItem","type":"object"},"HTTPMethodEnum":{"enum":["GET","HEAD","POST","PUT","DELETE","CONNECT","TRACE","OPTIONS","PATCH"],"title":"HTTPMethodEnum","type":"string"},"ResponseCreate":{"title":"ResponseCreate","type":"object","properties":{"message":{"title":"Message","description":"Information about successful create operation","type":"string"}},"required":["message"]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Delete Flow Control Policies

> Delete all Flow Control Policies in a configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/flow-control-policies":{"delete":{"description":"Delete all Flow Control Policies in a configuration","operationId":"document_resource_delete_api_v3_configs__config__d__document___delete_18696332526555447","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDelete"}}},"description":"Flow Control Policies deleted successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Delete Flow Control Policies","tags":["Flow Control Policies"]}}},"components":{"schemas":{"ResponseDelete":{"title":"ResponseDelete","type":"object","properties":{"message":{"title":"Message","description":"Information about successful delete operation","type":"string"}},"required":["message"]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Get specific Flow Control Policy

> Get a Flow Control Policy from the specified configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/flow-control-policies/{entry_id}":{"get":{"operationId":"entry_resource_get_api_v3_configs__config__d__document__e__entry___get_1161522589225571987","summary":"Get specific Flow Control Policy","description":"Get a Flow Control Policy from the specified configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"title":"Entry","type":"string"}}],"responses":{"200":{"description":"Flow Control Policy retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowControl"}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Flow Control Policies"]}}},"components":{"schemas":{"FlowControl":{"additionalProperties":false,"properties":{"active":{"description":"This flow is active","title":"Active flag","type":"boolean"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Description"},"exclude":{"default":[],"description":"Tags describing requests to exclude from the flow control rule","items":{"type":"string"},"title":"Excluded tags","type":"array"},"id":{"title":"Id","type":"string"},"include":{"default":[],"description":"Tags describing requests to include in the flow control rule","items":{"type":"string"},"title":"Included tags","type":"array"},"key":{"items":{"$ref":"#/components/schemas/FlowControlKeyEntry"},"title":"Key","type":"array","default":[]},"name":{"minLength":1,"title":"Name","type":"string"},"steps":{"description":"Array of sections describing steps of restricted flow","items":{"$ref":"#/components/schemas/FlowStepItem"},"title":"Steps","type":"array","default":[]},"tags":{"default":[],"description":"List of tags to apply","items":{"type":"string"},"title":"Tags List","type":"array"},"timeframe":{"description":"The time in which to limit the requests according to the threshold","title":"Time To Limit","type":"number"}},"required":["id","name","timeframe","key","steps","active"],"title":"FlowControl","type":"object"},"FlowControlKeyEntry":{"additionalProperties":false,"properties":{"args":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Arguments"},"attrs":{"anyOf":[{"$ref":"#/components/schemas/AttributesEnum"},{"type":"null"}],"default":null,"title":"Attributes"},"cookies":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Headers"},"plugins":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Plugins"}},"title":"KeyEntry","type":"object"},"AttributesEnum":{"enum":["asnFlowSef","authority","company","country","ip","method","network","path","query","region","secpolentryid","securitypolicyentryid","securitypolicyentry","secpolid","securitypolicyid","securitypolicy","secpolname","securitypolicyname","secpolentryname","securitypolicyentryname","session","subregion","tags","uri"],"title":"AttributesEnum","type":"string"},"FlowStepItem":{"properties":{"args":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Args"},"cookies":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Headers"},"method":{"$ref":"#/components/schemas/HTTPMethodEnum"},"plugins":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Plugins"},"uri":{"title":"Uri","type":"string"}},"required":["method","uri"],"title":"FlowStepItem","type":"object"},"HTTPMethodEnum":{"enum":["GET","HEAD","POST","PUT","DELETE","CONNECT","TRACE","OPTIONS","PATCH"],"title":"HTTPMethodEnum","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Modify a single Flow Control Policy

> Update an individual Flow Control Policy within a configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/flow-control-policies/{entry_id}":{"put":{"operationId":"entry_resource_put_api_v3_configs__config__d__document__e__entry___put_1161522589225571987","summary":"Modify a single Flow Control Policy","description":"Update an individual Flow Control Policy within a configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"title":"Entry","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowControl"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUpdate"}}},"description":"Flow Control Policy updated successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Flow Control Policies"]}}},"components":{"schemas":{"FlowControl":{"additionalProperties":false,"properties":{"active":{"description":"This flow is active","title":"Active flag","type":"boolean"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Description"},"exclude":{"default":[],"description":"Tags describing requests to exclude from the flow control rule","items":{"type":"string"},"title":"Excluded tags","type":"array"},"id":{"title":"Id","type":"string"},"include":{"default":[],"description":"Tags describing requests to include in the flow control rule","items":{"type":"string"},"title":"Included tags","type":"array"},"key":{"items":{"$ref":"#/components/schemas/FlowControlKeyEntry"},"title":"Key","type":"array","default":[]},"name":{"minLength":1,"title":"Name","type":"string"},"steps":{"description":"Array of sections describing steps of restricted flow","items":{"$ref":"#/components/schemas/FlowStepItem"},"title":"Steps","type":"array","default":[]},"tags":{"default":[],"description":"List of tags to apply","items":{"type":"string"},"title":"Tags List","type":"array"},"timeframe":{"description":"The time in which to limit the requests according to the threshold","title":"Time To Limit","type":"number"}},"required":["id","name","timeframe","key","steps","active"],"title":"FlowControl","type":"object"},"FlowControlKeyEntry":{"additionalProperties":false,"properties":{"args":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Arguments"},"attrs":{"anyOf":[{"$ref":"#/components/schemas/AttributesEnum"},{"type":"null"}],"default":null,"title":"Attributes"},"cookies":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Headers"},"plugins":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Plugins"}},"title":"KeyEntry","type":"object"},"AttributesEnum":{"enum":["asnFlowSef","authority","company","country","ip","method","network","path","query","region","secpolentryid","securitypolicyentryid","securitypolicyentry","secpolid","securitypolicyid","securitypolicy","secpolname","securitypolicyname","secpolentryname","securitypolicyentryname","session","subregion","tags","uri"],"title":"AttributesEnum","type":"string"},"FlowStepItem":{"properties":{"args":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Args"},"cookies":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Headers"},"method":{"$ref":"#/components/schemas/HTTPMethodEnum"},"plugins":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Plugins"},"uri":{"title":"Uri","type":"string"}},"required":["method","uri"],"title":"FlowStepItem","type":"object"},"HTTPMethodEnum":{"enum":["GET","HEAD","POST","PUT","DELETE","CONNECT","TRACE","OPTIONS","PATCH"],"title":"HTTPMethodEnum","type":"string"},"ResponseUpdate":{"title":"ResponseUpdate","type":"object","properties":{"message":{"title":"Message","description":"Information about successful update operation","type":"string"}},"required":["message"]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Create single Flow Control Policy

> Create an individual Flow Control Policy within a configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/flow-control-policies/{entry_id}":{"post":{"operationId":"entries_resource_post_api_v3_configs__config__d__document__e__post_2091894710826690054","summary":"Create single Flow Control Policy","description":"Create an individual Flow Control Policy within a configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"title":"Entry","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowControl"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreate"}}},"description":"Flow Control Policy created successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Flow Control Policies"]}}},"components":{"schemas":{"FlowControl":{"additionalProperties":false,"properties":{"active":{"description":"This flow is active","title":"Active flag","type":"boolean"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Description"},"exclude":{"default":[],"description":"Tags describing requests to exclude from the flow control rule","items":{"type":"string"},"title":"Excluded tags","type":"array"},"id":{"title":"Id","type":"string"},"include":{"default":[],"description":"Tags describing requests to include in the flow control rule","items":{"type":"string"},"title":"Included tags","type":"array"},"key":{"items":{"$ref":"#/components/schemas/FlowControlKeyEntry"},"title":"Key","type":"array","default":[]},"name":{"minLength":1,"title":"Name","type":"string"},"steps":{"description":"Array of sections describing steps of restricted flow","items":{"$ref":"#/components/schemas/FlowStepItem"},"title":"Steps","type":"array","default":[]},"tags":{"default":[],"description":"List of tags to apply","items":{"type":"string"},"title":"Tags List","type":"array"},"timeframe":{"description":"The time in which to limit the requests according to the threshold","title":"Time To Limit","type":"number"}},"required":["id","name","timeframe","key","steps","active"],"title":"FlowControl","type":"object"},"FlowControlKeyEntry":{"additionalProperties":false,"properties":{"args":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Arguments"},"attrs":{"anyOf":[{"$ref":"#/components/schemas/AttributesEnum"},{"type":"null"}],"default":null,"title":"Attributes"},"cookies":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Headers"},"plugins":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Plugins"}},"title":"KeyEntry","type":"object"},"AttributesEnum":{"enum":["asnFlowSef","authority","company","country","ip","method","network","path","query","region","secpolentryid","securitypolicyentryid","securitypolicyentry","secpolid","securitypolicyid","securitypolicy","secpolname","securitypolicyname","secpolentryname","securitypolicyentryname","session","subregion","tags","uri"],"title":"AttributesEnum","type":"string"},"FlowStepItem":{"properties":{"args":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Args"},"cookies":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Headers"},"method":{"$ref":"#/components/schemas/HTTPMethodEnum"},"plugins":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Plugins"},"uri":{"title":"Uri","type":"string"}},"required":["method","uri"],"title":"FlowStepItem","type":"object"},"HTTPMethodEnum":{"enum":["GET","HEAD","POST","PUT","DELETE","CONNECT","TRACE","OPTIONS","PATCH"],"title":"HTTPMethodEnum","type":"string"},"ResponseCreate":{"title":"ResponseCreate","type":"object","properties":{"message":{"title":"Message","description":"Information about successful create operation","type":"string"}},"required":["message"]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Delete single Flow Control Policy

> Delete an individual Flow Control Policy from the specified configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/flow-control-policies/{entry_id}":{"delete":{"operationId":"entry_resource_delete_api_v3_configs__config__d__document__e__entry___delete_1161522589225571987","summary":"Delete single Flow Control Policy","description":"Delete an individual Flow Control Policy from the specified configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"title":"Entry","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDelete"}}},"description":"Flow Control Policy deleted successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Flow Control Policies"]}}},"components":{"schemas":{"ResponseDelete":{"title":"ResponseDelete","type":"object","properties":{"message":{"title":"Message","description":"Information about successful delete operation","type":"string"}},"required":["message"]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Get Flow Control Policies version list

> Get list of versions of Flow Control Policies in a configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/flow-control-policies/versions":{"get":{"operationId":"document_list_version_resource_get_api_v3_configs__config__d__document__v__get_243192244709770866","summary":"Get Flow Control Policies version list","description":"Get list of versions of Flow Control Policies in a configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"title":"Versions list","properties":{"total":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/VersionEntry"}}}}}},"description":"Flow Control Policies version list retrieved successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Flow Control Policies"]}}},"components":{"schemas":{"VersionEntry":{"title":"VersionEntry","type":"object","properties":{"author":{"title":"Author","type":"string"},"email":{"title":"Email","format":"email","type":"string"},"message":{"title":"Message","type":"string"},"date":{"format":"date-time","title":"Date","type":"string"},"version":{"title":"Version","type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Get version of Flow Control Policy

> Get a specific version of a Flow Control Policy

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/flow-control-policies/versions/{version}":{"get":{"operationId":"document_version_resource_get_api_v3_configs__config__d__document__v__version___get_1332957339605358508","summary":"Get version of Flow Control Policy","description":"Get a specific version of a Flow Control Policy","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}},{"in":"path","name":"version","required":true,"schema":{"title":"Version","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"title":"Flow Control Policies document","properties":{"total":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/FlowControl"}}}}}},"description":"Flow Control Policy retrieved successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Flow Control Policies"]}}},"components":{"schemas":{"FlowControl":{"additionalProperties":false,"properties":{"active":{"description":"This flow is active","title":"Active flag","type":"boolean"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Description"},"exclude":{"default":[],"description":"Tags describing requests to exclude from the flow control rule","items":{"type":"string"},"title":"Excluded tags","type":"array"},"id":{"title":"Id","type":"string"},"include":{"default":[],"description":"Tags describing requests to include in the flow control rule","items":{"type":"string"},"title":"Included tags","type":"array"},"key":{"items":{"$ref":"#/components/schemas/FlowControlKeyEntry"},"title":"Key","type":"array","default":[]},"name":{"minLength":1,"title":"Name","type":"string"},"steps":{"description":"Array of sections describing steps of restricted flow","items":{"$ref":"#/components/schemas/FlowStepItem"},"title":"Steps","type":"array","default":[]},"tags":{"default":[],"description":"List of tags to apply","items":{"type":"string"},"title":"Tags List","type":"array"},"timeframe":{"description":"The time in which to limit the requests according to the threshold","title":"Time To Limit","type":"number"}},"required":["id","name","timeframe","key","steps","active"],"title":"FlowControl","type":"object"},"FlowControlKeyEntry":{"additionalProperties":false,"properties":{"args":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Arguments"},"attrs":{"anyOf":[{"$ref":"#/components/schemas/AttributesEnum"},{"type":"null"}],"default":null,"title":"Attributes"},"cookies":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Headers"},"plugins":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Plugins"}},"title":"KeyEntry","type":"object"},"AttributesEnum":{"enum":["asnFlowSef","authority","company","country","ip","method","network","path","query","region","secpolentryid","securitypolicyentryid","securitypolicyentry","secpolid","securitypolicyid","securitypolicy","secpolname","securitypolicyname","secpolentryname","securitypolicyentryname","session","subregion","tags","uri"],"title":"AttributesEnum","type":"string"},"FlowStepItem":{"properties":{"args":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Args"},"cookies":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Cookies"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Headers"},"method":{"$ref":"#/components/schemas/HTTPMethodEnum"},"plugins":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"default":null,"title":"Plugins"},"uri":{"title":"Uri","type":"string"}},"required":["method","uri"],"title":"FlowStepItem","type":"object"},"HTTPMethodEnum":{"enum":["GET","HEAD","POST","PUT","DELETE","CONNECT","TRACE","OPTIONS","PATCH"],"title":"HTTPMethodEnum","type":"string"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Revert a Flow Control Policy to the specified version

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

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/flow-control-policies/versions/{version}/revert":{"put":{"operationId":"document_revert_resource_put_api_v3_configs__config__d__document__v__version__revert__put_284329767158655723","summary":"Revert a Flow Control Policy to the specified version","description":"Set a previous Flow Control Policy version to be the current one","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}},{"in":"path","name":"version","required":true,"schema":{"title":"Version","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUpdate"}}},"description":"Flow Control Policy reversion was successful"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Flow Control Policies"]}}},"components":{"schemas":{"ResponseUpdate":{"title":"ResponseUpdate","type":"object","properties":{"message":{"title":"Message","description":"Information about successful update operation","type":"string"}},"required":["message"]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```