Skip to content
Start here

DDoS Protection

DDoS ProtectionAdvanced TCP Protection

DDoS ProtectionAdvanced TCP ProtectionAllowlist

List all allowlist prefixes.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist
Create allowlist prefix.
POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist
Delete all allowlist prefixes.
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist
ModelsExpand Collapse
AllowlistListResponse object { id, comment, created_on, 3 more }
id: string

The unique ID of the allowlist prefix.

comment: string

An optional comment describing the allowlist prefix.

created_on: string

The creation timestamp of the allowlist prefix.

formatdate-time
enabled: boolean

Whether to enable the allowlist prefix into effect. Defaults to false.

modified_on: string

The last modification timestamp of the allowlist prefix.

formatdate-time
prefix: string

The allowlist prefix in CIDR format.

AllowlistCreateResponse object { id, comment, created_on, 3 more }
id: string

The unique ID of the allowlist prefix.

comment: string

An optional comment describing the allowlist prefix.

created_on: string

The creation timestamp of the allowlist prefix.

formatdate-time
enabled: boolean

Whether to enable the allowlist prefix into effect. Defaults to false.

modified_on: string

The last modification timestamp of the allowlist prefix.

formatdate-time
prefix: string

The allowlist prefix in CIDR format.

AllowlistBulkDeleteResponse 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.

DDoS ProtectionAdvanced TCP ProtectionAllowlistItems

Get allowlist prefix.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id}
Update allowlist prefix.
PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id}
Delete allowlist prefix.
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id}
ModelsExpand Collapse
ItemGetResponse object { id, comment, created_on, 3 more }
id: string

The unique ID of the allowlist prefix.

comment: string

An optional comment describing the allowlist prefix.

created_on: string

The creation timestamp of the allowlist prefix.

formatdate-time
enabled: boolean

Whether to enable the allowlist prefix into effect. Defaults to false.

modified_on: string

The last modification timestamp of the allowlist prefix.

formatdate-time
prefix: string

The allowlist prefix in CIDR format.

ItemEditResponse object { id, comment, created_on, 3 more }
id: string

The unique ID of the allowlist prefix.

comment: string

An optional comment describing the allowlist prefix.

created_on: string

The creation timestamp of the allowlist prefix.

formatdate-time
enabled: boolean

Whether to enable the allowlist prefix into effect. Defaults to false.

modified_on: string

The last modification timestamp of the allowlist prefix.

formatdate-time
prefix: string

The allowlist prefix in CIDR format.

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.

DDoS ProtectionAdvanced TCP ProtectionPrefixes

List all prefixes.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes
Create prefix.
POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes
Delete all prefixes.
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes
Create multiple prefixes.
POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/bulk
ModelsExpand Collapse
PrefixListResponse object { id, comment, created_on, 3 more }
id: string

The unique ID of the prefix.

comment: string

A comment describing the prefix.

created_on: string

The creation timestamp of the prefix.

formatdate-time
excluded: boolean

Whether to exclude the prefix from protection.

modified_on: string

The last modification timestamp of the prefix.

formatdate-time
prefix: string

The prefix in CIDR format.

PrefixCreateResponse object { id, comment, created_on, 3 more }
id: string

The unique ID of the prefix.

comment: string

A comment describing the prefix.

created_on: string

The creation timestamp of the prefix.

formatdate-time
excluded: boolean

Whether to exclude the prefix from protection.

modified_on: string

The last modification timestamp of the prefix.

formatdate-time
prefix: string

The prefix in CIDR format.

PrefixBulkDeleteResponse 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.

PrefixBulkCreateResponse object { id, comment, created_on, 3 more }
id: string

The unique ID of the prefix.

comment: string

A comment describing the prefix.

created_on: string

The creation timestamp of the prefix.

formatdate-time
excluded: boolean

Whether to exclude the prefix from protection.

modified_on: string

The last modification timestamp of the prefix.

formatdate-time
prefix: string

The prefix in CIDR format.

DDoS ProtectionAdvanced TCP ProtectionPrefixesItems

Get prefix.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id}
Update prefix.
PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id}
Delete prefix.
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id}
ModelsExpand Collapse
ItemGetResponse object { id, comment, created_on, 3 more }
id: string

The unique ID of the prefix.

comment: string

A comment describing the prefix.

created_on: string

The creation timestamp of the prefix.

formatdate-time
excluded: boolean

Whether to exclude the prefix from protection.

modified_on: string

The last modification timestamp of the prefix.

formatdate-time
prefix: string

The prefix in CIDR format.

ItemEditResponse object { id, comment, created_on, 3 more }
id: string

The unique ID of the prefix.

comment: string

A comment describing the prefix.

created_on: string

The creation timestamp of the prefix.

formatdate-time
excluded: boolean

Whether to exclude the prefix from protection.

modified_on: string

The last modification timestamp of the prefix.

formatdate-time
prefix: string

The prefix in CIDR format.

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.

DDoS ProtectionAdvanced TCP ProtectionSYN Protection

DDoS ProtectionAdvanced TCP ProtectionSYN ProtectionFilters

List all SYN Protection filters.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters
Create a SYN Protection filter.
POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters
Delete all SYN Protection filters.
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters
ModelsExpand Collapse
FilterListResponse object { id, created_on, expression, 2 more }
id: string

The unique ID of the expression filter.

created_on: string

The creation timestamp of the expression filter.

formatdate-time
expression: string

The filter expression.

mode: string

The filter’s mode. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

modified_on: string

The last modification timestamp of the expression filter.

formatdate-time
FilterCreateResponse object { id, created_on, expression, 2 more }
id: string

The unique ID of the expression filter.

created_on: string

The creation timestamp of the expression filter.

formatdate-time
expression: string

The filter expression.

mode: string

The filter’s mode. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

modified_on: string

The last modification timestamp of the expression filter.

formatdate-time
FilterBulkDeleteResponse 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.

DDoS ProtectionAdvanced TCP ProtectionSYN ProtectionFiltersItems

Get SYN Protection filter.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters/{filter_id}
Update SYN Protection filter.
PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters/{filter_id}
Delete SYN Protection filter.
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters/{filter_id}
ModelsExpand Collapse
ItemGetResponse object { id, created_on, expression, 2 more }
id: string

The unique ID of the expression filter.

created_on: string

The creation timestamp of the expression filter.

formatdate-time
expression: string

The filter expression.

mode: string

The filter’s mode. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

modified_on: string

The last modification timestamp of the expression filter.

formatdate-time
ItemEditResponse object { id, created_on, expression, 2 more }
id: string

The unique ID of the expression filter.

created_on: string

The creation timestamp of the expression filter.

formatdate-time
expression: string

The filter expression.

mode: string

The filter’s mode. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

modified_on: string

The last modification timestamp of the expression filter.

formatdate-time
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.

DDoS ProtectionAdvanced TCP ProtectionSYN ProtectionRules

List all SYN Protection rules.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules
Create SYN Protection rule.
POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules
Delete all SYN Protection rules.
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules
ModelsExpand Collapse
RuleListResponse object { id, burst_sensitivity, created_on, 6 more }
id: string

The unique ID of the SYN Protection rule.

burst_sensitivity: string

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

created_on: string

The creation timestamp of the SYN Protection rule.

formatdate-time
mitigation_type: string

The type of mitigation for SYN Protection. Must be one of ‘challenge’ or ‘retransmit’.

mode: string

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

modified_on: string

The last modification timestamp of the SYN Protection rule.

formatdate-time
name: string

The name of the SYN 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 SYN Protection rule. Must be one of ‘global’, ‘region’, or ‘datacenter’.

RuleCreateResponse object { id, burst_sensitivity, created_on, 6 more }
id: string

The unique ID of the SYN Protection rule.

burst_sensitivity: string

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

created_on: string

The creation timestamp of the SYN Protection rule.

formatdate-time
mitigation_type: string

The type of mitigation for SYN Protection. Must be one of ‘challenge’ or ‘retransmit’.

mode: string

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

modified_on: string

The last modification timestamp of the SYN Protection rule.

formatdate-time
name: string

The name of the SYN 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 SYN 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.

DDoS ProtectionAdvanced TCP ProtectionSYN ProtectionRulesItems

Get SYN Protection rule.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules/{rule_id}
Update SYN Protection rule.
PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules/{rule_id}
Delete SYN Protection rule.
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules/{rule_id}
ModelsExpand Collapse
ItemGetResponse object { id, burst_sensitivity, created_on, 6 more }
id: string

The unique ID of the SYN Protection rule.

burst_sensitivity: string

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

created_on: string

The creation timestamp of the SYN Protection rule.

formatdate-time
mitigation_type: string

The type of mitigation for SYN Protection. Must be one of ‘challenge’ or ‘retransmit’.

mode: string

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

modified_on: string

The last modification timestamp of the SYN Protection rule.

formatdate-time
name: string

The name of the SYN 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 SYN Protection rule. Must be one of ‘global’, ‘region’, or ‘datacenter’.

ItemEditResponse object { id, burst_sensitivity, created_on, 6 more }
id: string

The unique ID of the SYN Protection rule.

burst_sensitivity: string

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

created_on: string

The creation timestamp of the SYN Protection rule.

formatdate-time
mitigation_type: string

The type of mitigation for SYN Protection. Must be one of ‘challenge’ or ‘retransmit’.

mode: string

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

modified_on: string

The last modification timestamp of the SYN Protection rule.

formatdate-time
name: string

The name of the SYN 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 SYN 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.

DDoS ProtectionAdvanced TCP ProtectionTCP Flow Protection

DDoS ProtectionAdvanced TCP ProtectionTCP Flow ProtectionFilters

List all TCP Flow Protection filters.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters
Create a TCP Flow Protection filter.
POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters
Delete all TCP Flow Protection filters.
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters
ModelsExpand Collapse
FilterListResponse object { id, created_on, expression, 2 more }
id: string

The unique ID of the expression filter.

created_on: string

The creation timestamp of the expression filter.

formatdate-time
expression: string

The filter expression.

mode: string

The filter’s mode. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

modified_on: string

The last modification timestamp of the expression filter.

formatdate-time
FilterCreateResponse object { id, created_on, expression, 2 more }
id: string

The unique ID of the expression filter.

created_on: string

The creation timestamp of the expression filter.

formatdate-time
expression: string

The filter expression.

mode: string

The filter’s mode. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

modified_on: string

The last modification timestamp of the expression filter.

formatdate-time
FilterBulkDeleteResponse 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.

DDoS ProtectionAdvanced TCP ProtectionTCP Flow ProtectionFiltersItems

Get TCP Flow Protection filter.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters/{filter_id}
Update TCP Flow Protection filter.
PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters/{filter_id}
Delete TCP Flow Protection filter.
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters/{filter_id}
ModelsExpand Collapse
ItemGetResponse object { id, created_on, expression, 2 more }
id: string

The unique ID of the expression filter.

created_on: string

The creation timestamp of the expression filter.

formatdate-time
expression: string

The filter expression.

mode: string

The filter’s mode. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

modified_on: string

The last modification timestamp of the expression filter.

formatdate-time
ItemEditResponse object { id, created_on, expression, 2 more }
id: string

The unique ID of the expression filter.

created_on: string

The creation timestamp of the expression filter.

formatdate-time
expression: string

The filter expression.

mode: string

The filter’s mode. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

modified_on: string

The last modification timestamp of the expression filter.

formatdate-time
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.

DDoS ProtectionAdvanced TCP ProtectionTCP Flow ProtectionRules

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.

DDoS ProtectionAdvanced TCP ProtectionTCP Flow ProtectionRulesItems

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.

DDoS ProtectionAdvanced TCP ProtectionStatus

Get protection status.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_protection_status
Update protection status.
PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_protection_status
ModelsExpand Collapse
StatusGetResponse object { enabled }
enabled: boolean
StatusEditResponse object { enabled }
enabled: boolean