--- title: Common API calls description: Example API requests for managing Advanced TCP Protection prefixes, allowlists, and rules. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/ddos-protection/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) ### Tags [ REST API ](https://developers.cloudflare.com/search/?tags=REST%20API) # Common API calls The following sections contain example requests for common API calls. For a list of available API endpoints, refer to [Endpoints](https://developers.cloudflare.com/ddos-protection/advanced-ddos-systems/api/tcp-protection/#endpoints). ## Get Advanced TCP Protection status This example obtains the current status of Advanced TCP Protection (enabled or disabled). Request ``` curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_protection_status \ --header "Authorization: Bearer " ``` Example response ``` { "result": { "enabled": false }, "success": true, "errors": [], "messages": [] } ``` ## Enable Advanced TCP Protection This example enables Advanced TCP Protection. Request ``` curl --request PATCH \ https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_protection_status \ --header "Authorization: Bearer " \ --header "Content-Type: application/json" \ --data '{ "enabled": true }' ``` ## Get existing prefixes This example fetches all existing prefixes in Advanced TCP Protection. Request ``` curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes \ --header "Authorization: Bearer " ``` ``` { "result": [ { "prefix": "203.0.113/24", "comment": "My prefix", "excluded": false } ], "success": true, "errors": [], "messages": [] } ``` ## Add prefixes This example `POST` request adds two prefixes. The second prefix excludes a subset of the first prefix from Advanced TCP Protection. Request ``` curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/bulk \ --header "Authorization: Bearer " \ --header "Content-Type: application/json" \ --data '[ { "prefix": "192.0.2.0/24", "comment": "Game ranges", "excluded": false }, { "prefix": "192.0.2.2/26", "comment": "Range for a specific game", "excluded": true } ]' ``` ``` { "result": [ { "id": "", "prefix": "192.0.2.0/24", "excluded": false, "comment": "Game ranges", "created_on": "", "modified_on": "" }, { "id": "", "prefix": "192.0.2.2/26", "excluded": true, "comment": "Range for a specific game", "created_on": "", "modified_on": "" } ], "success": true, "errors": [], "messages": [] } ``` ## Get all prefixes in allowlist This example fetches all the prefixes in the allowlist. Request ``` curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist \ --header "Authorization: Bearer " ``` ``` { "result": [ { "id": "", "prefix": "192.0.2.127", "comment": "Single IP address in allowlist", "enabled": true, "created_on": "", "modified_on": "" } ], "success": true, "errors": [], "messages": [] } ``` ## Add a prefix to the allowlist This example `POST` request adds a prefix to the allowlist of the account. Request ``` curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist \ --header "Authorization: Bearer " \ --header "Content-Type: application/json" \ --data '{ "prefix": "203.0.113.0/26", "comment": "Partner range", "enabled": true }' ``` ``` { "result": { "id": "", "prefix": "203.0.113.0/26", "comment": "Partner range", "enabled": true, "created_on": "", "modified_on": "" }, "success": true, "errors": [], "messages": [] } ``` ## Create a SYN flood rule This example `POST` request creates a SYN flood rule with a regional scope (Western Europe) in monitoring mode. Request ``` curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules \ --header "Authorization: Bearer " \ --header "Content-Type: application/json" \ --data '{ "scope": "region", "name": "WEUR", "mode": "monitoring", "rate_sensitivity": "medium", "burst_sensitivity": "medium" }' ``` ``` { "result": { "id": "", "scope": "region", "name": "WEUR", "mode": "monitoring", "rate_sensitivity": "medium", "burst_sensitivity": "medium", "created_on": "", "modified_on": "" }, "success": true, "errors": [], "messages": [] } ``` Refer to [JSON objects](https://developers.cloudflare.com/ddos-protection/advanced-ddos-systems/api/tcp-protection/json-objects/) for more information on the fields in the JSON body. ## Create an out-of-state TCP rule This example `POST` request creates an out-of-state TCP rule in monitoring mode, with a regional scope, and with low rate and burst sensitivities. Request ``` curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules \ --header "Authorization: Bearer " \ --header "Content-Type: application/json" \ --data '{ "scope": "region", "name": "WEUR", "mode": "monitoring", "rate_sensitivity": "low", "burst_sensitivity": "low" }' ``` ``` { "result": { "id": "", "scope": "region", "name": "WEUR", "mode": "monitoring", "rate_sensitivity": "low", "burst_sensitivity": "low", "created_on": "", "modified_on": "" }, "success": true, "errors": [], "messages": [] } ``` Refer to [JSON objects](https://developers.cloudflare.com/ddos-protection/advanced-ddos-systems/api/tcp-protection/json-objects/) for more information on the fields in the JSON body. ## Create a SYN flood filter This example `POST` request creates a SYN flood [filter](https://developers.cloudflare.com/ddos-protection/advanced-ddos-systems/concepts/#filter), setting SYN flood protection to monitoring mode for a specific range of destination IP addresses. Request ``` curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters \ --header "Authorization: Bearer " \ --header "Content-Type: application/json" \ --data '{ "expression": "ip.dst in { 192.0.2.0/24 }", "mode": "monitoring" }' ``` ``` { "result": { "id": "", "expression": "ip.dst in { 192.0.2.0/24 }", "mode": "monitoring", "created_on": "", "modified_on": "" }, "success": true, "errors": [], "messages": [] } ``` Refer to [JSON objects](https://developers.cloudflare.com/ddos-protection/advanced-ddos-systems/api/tcp-protection/json-objects/) for more information on the fields in the JSON body. ## Create an out-of-state TCP filter This example `POST` request creates an out-of-state TCP [filter](https://developers.cloudflare.com/ddos-protection/advanced-ddos-systems/concepts/#filter), disabling out-of-state TCP protection for a specific range of destination IP addresses and ports. Request ``` curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters \ --header "Authorization: Bearer " \ --header "Content-Type: application/json" \ --data '{ "expression": "ip.dst in { 203.0.113.0/24 } and tcp.dstport in { 8000..8081 }", "mode": "disabled" }' ``` ``` { "result": { "id": "", "expression": "ip.dst in { 203.0.113.0/24 } and tcp.dstport in { 8000..8081 }", "mode": "disabled", "created_on": "", "modified_on": "" }, "success": true, "errors": [], "messages": [] } ``` Refer to [JSON objects](https://developers.cloudflare.com/ddos-protection/advanced-ddos-systems/api/tcp-protection/json-objects/) for more information on the fields in the JSON body. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/ddos-protection/","name":"DDoS Protection"}},{"@type":"ListItem","position":3,"item":{"@id":"/ddos-protection/advanced-ddos-systems/","name":"Advanced DDoS systems"}},{"@type":"ListItem","position":4,"item":{"@id":"/ddos-protection/advanced-ddos-systems/api/","name":"API configuration"}},{"@type":"ListItem","position":5,"item":{"@id":"/ddos-protection/advanced-ddos-systems/api/tcp-protection/","name":"Advanced TCP Protection"}},{"@type":"ListItem","position":6,"item":{"@id":"/ddos-protection/advanced-ddos-systems/api/tcp-protection/examples/","name":"Common API calls"}}]} ```