API Reference

DDoS Protection

Advanced TCP Protection

TCP Flow Protection

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Rules

List all TCP Flow Protection rules.

GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules

Create TCP Flow Protection rule.

POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules

Delete all TCP Flow Protection rules.

DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules

ModelsExpand Collapse

RuleListResponse object { id, burst_sensitivity, created_on, 5 more }

id: string

The unique ID of the TCP Flow Protection rule.

burst_sensitivity: string

The burst sensitivity. Must be one of ‘low’, ‘medium’, ‘high’.

created_on: string

The creation timestamp of the TCP Flow Protection rule.

formatdate-time

mode: string

The mode for TCP Flow Protection. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

modified_on: string

The last modification timestamp of the TCP Flow Protection rule.

formatdate-time

name: string

The name of the TCP Flow Protection rule. Value is relative to the ‘scope’ setting. For ‘global’ scope, name should be ‘global’. For either the ‘region’ or ‘datacenter’ scope, name should be the actual name of the region or datacenter, e.g., ‘wnam’ or ‘lax’.

rate_sensitivity: string

The rate sensitivity. Must be one of ‘low’, ‘medium’, ‘high’.

scope: string

The scope for the TCP Flow Protection rule. Must be one of ‘global’, ‘region’, or ‘datacenter’.

RuleCreateResponse object { id, burst_sensitivity, created_on, 5 more }

id: string

The unique ID of the TCP Flow Protection rule.

burst_sensitivity: string

The burst sensitivity. Must be one of ‘low’, ‘medium’, ‘high’.

created_on: string

The creation timestamp of the TCP Flow Protection rule.

formatdate-time

mode: string

The mode for TCP Flow Protection. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

modified_on: string

The last modification timestamp of the TCP Flow Protection rule.

formatdate-time

name: string

The name of the TCP Flow Protection rule. Value is relative to the ‘scope’ setting. For ‘global’ scope, name should be ‘global’. For either the ‘region’ or ‘datacenter’ scope, name should be the actual name of the region or datacenter, e.g., ‘wnam’ or ‘lax’.

rate_sensitivity: string

The rate sensitivity. Must be one of ‘low’, ‘medium’, ‘high’.

scope: string

The scope for the TCP Flow Protection rule. Must be one of ‘global’, ‘region’, or ‘datacenter’.

RuleBulkDeleteResponse object { errors, messages, success }

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

RulesItems

Get TCP Flow Protection rule.

GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules/{rule_id}

Update TCP Flow Protection rule.

PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules/{rule_id}

Delete TCP Flow Protection rule.

DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules/{rule_id}

ModelsExpand Collapse

ItemGetResponse object { id, burst_sensitivity, created_on, 5 more }

id: string

The unique ID of the TCP Flow Protection rule.

burst_sensitivity: string

The burst sensitivity. Must be one of ‘low’, ‘medium’, ‘high’.

created_on: string

The creation timestamp of the TCP Flow Protection rule.

formatdate-time

mode: string

The mode for TCP Flow Protection. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

modified_on: string

The last modification timestamp of the TCP Flow Protection rule.

formatdate-time

name: string

The name of the TCP Flow Protection rule. Value is relative to the ‘scope’ setting. For ‘global’ scope, name should be ‘global’. For either the ‘region’ or ‘datacenter’ scope, name should be the actual name of the region or datacenter, e.g., ‘wnam’ or ‘lax’.

rate_sensitivity: string

The rate sensitivity. Must be one of ‘low’, ‘medium’, ‘high’.

scope: string

The scope for the TCP Flow Protection rule. Must be one of ‘global’, ‘region’, or ‘datacenter’.

ItemEditResponse object { id, burst_sensitivity, created_on, 5 more }

id: string

The unique ID of the TCP Flow Protection rule.

burst_sensitivity: string

The burst sensitivity. Must be one of ‘low’, ‘medium’, ‘high’.

created_on: string

The creation timestamp of the TCP Flow Protection rule.

formatdate-time

mode: string

The mode for TCP Flow Protection. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

modified_on: string

The last modification timestamp of the TCP Flow Protection rule.

formatdate-time

name: string

The name of the TCP Flow Protection rule. Value is relative to the ‘scope’ setting. For ‘global’ scope, name should be ‘global’. For either the ‘region’ or ‘datacenter’ scope, name should be the actual name of the region or datacenter, e.g., ‘wnam’ or ‘lax’.

rate_sensitivity: string

The rate sensitivity. Must be one of ‘low’, ‘medium’, ‘high’.

scope: string

The scope for the TCP Flow Protection rule. Must be one of ‘global’, ‘region’, or ‘datacenter’.

ItemDeleteResponse object { errors, messages, success }

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.