API Reference

DDoS Protection

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Advanced TCP Protection

Advanced TCP ProtectionAllowlist

List all allowlist prefixes.

client.DDoSProtection.advancedTCPProtection.allowlist.list(AllowlistListParams { account_id, direction, order, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<AllowlistListResponse { id, comment, created_on, 3 more } >

GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist

Create allowlist prefix.

client.DDoSProtection.advancedTCPProtection.allowlist.create(AllowlistCreateParams { account_id, comment, enabled, prefix } params, RequestOptionsoptions?): AllowlistCreateResponse { id, comment, created_on, 3 more }

POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist

Delete all allowlist prefixes.

client.DDoSProtection.advancedTCPProtection.allowlist.bulkDelete(AllowlistBulkDeleteParams { account_id } params, RequestOptionsoptions?): AllowlistBulkDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist

ModelsExpand Collapse

AllowlistListResponse { 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 { 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 { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

Advanced TCP ProtectionAllowlistItems

Get allowlist prefix.

client.DDoSProtection.advancedTCPProtection.allowlist.items.get(stringprefixId, ItemGetParams { account_id } params, RequestOptionsoptions?): ItemGetResponse { id, comment, created_on, 3 more }

GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id}

Update allowlist prefix.

client.DDoSProtection.advancedTCPProtection.allowlist.items.edit(stringprefixId, ItemEditParams { account_id, comment, enabled } params, RequestOptionsoptions?): ItemEditResponse { id, comment, created_on, 3 more }

PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id}

Delete allowlist prefix.

client.DDoSProtection.advancedTCPProtection.allowlist.items.delete(stringprefixId, ItemDeleteParams { account_id } params, RequestOptionsoptions?): ItemDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id}

ModelsExpand Collapse

ItemGetResponse { 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 { 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 { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

Advanced TCP ProtectionPrefixes

List all prefixes.

client.DDoSProtection.advancedTCPProtection.prefixes.list(PrefixListParams { account_id, direction, order, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<PrefixListResponse { id, comment, created_on, 3 more } >

GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes

Create prefix.

client.DDoSProtection.advancedTCPProtection.prefixes.create(PrefixCreateParams { account_id, comment, excluded, prefix } params, RequestOptionsoptions?): PrefixCreateResponse { id, comment, created_on, 3 more }

POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes

Delete all prefixes.

client.DDoSProtection.advancedTCPProtection.prefixes.bulkDelete(PrefixBulkDeleteParams { account_id } params, RequestOptionsoptions?): PrefixBulkDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes

Create multiple prefixes.

client.DDoSProtection.advancedTCPProtection.prefixes.bulkCreate(PrefixBulkCreateParams { account_id, body } params, RequestOptionsoptions?): SinglePage<PrefixBulkCreateResponse { id, comment, created_on, 3 more } >

POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/bulk

ModelsExpand Collapse

PrefixListResponse { 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 { 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 { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

PrefixBulkCreateResponse { 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.

Advanced TCP ProtectionPrefixesItems

Get prefix.

client.DDoSProtection.advancedTCPProtection.prefixes.items.get(stringprefixId, ItemGetParams { account_id } params, RequestOptionsoptions?): ItemGetResponse { id, comment, created_on, 3 more }

GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id}

Update prefix.

client.DDoSProtection.advancedTCPProtection.prefixes.items.edit(stringprefixId, ItemEditParams { account_id, comment, excluded } params, RequestOptionsoptions?): ItemEditResponse { id, comment, created_on, 3 more }

PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id}

Delete prefix.

client.DDoSProtection.advancedTCPProtection.prefixes.items.delete(stringprefixId, ItemDeleteParams { account_id } params, RequestOptionsoptions?): ItemDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id}

ModelsExpand Collapse

ItemGetResponse { 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 { 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 { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

Advanced TCP ProtectionSYN Protection

Advanced TCP ProtectionSYN ProtectionFilters

List all SYN Protection filters.

client.DDoSProtection.advancedTCPProtection.synProtection.filters.list(FilterListParams { account_id, direction, mode, 3 more } params, RequestOptionsoptions?): V4PagePaginationArray<FilterListResponse { id, created_on, expression, 2 more } >

GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters

Create a SYN Protection filter.

client.DDoSProtection.advancedTCPProtection.synProtection.filters.create(FilterCreateParams { account_id, expression, mode } params, RequestOptionsoptions?): FilterCreateResponse { id, created_on, expression, 2 more }

POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters

Delete all SYN Protection filters.

client.DDoSProtection.advancedTCPProtection.synProtection.filters.bulkDelete(FilterBulkDeleteParams { account_id } params, RequestOptionsoptions?): FilterBulkDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters

ModelsExpand Collapse

FilterListResponse { 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 { 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 { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

Advanced TCP ProtectionSYN ProtectionFiltersItems

Get SYN Protection filter.

client.DDoSProtection.advancedTCPProtection.synProtection.filters.items.get(stringfilterId, ItemGetParams { account_id } params, RequestOptionsoptions?): ItemGetResponse { id, created_on, expression, 2 more }

GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters/{filter_id}

Update SYN Protection filter.

client.DDoSProtection.advancedTCPProtection.synProtection.filters.items.edit(stringfilterId, ItemEditParams { account_id, expression, mode } params, RequestOptionsoptions?): ItemEditResponse { id, created_on, expression, 2 more }

PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters/{filter_id}

Delete SYN Protection filter.

client.DDoSProtection.advancedTCPProtection.synProtection.filters.items.delete(stringfilterId, ItemDeleteParams { account_id } params, RequestOptionsoptions?): ItemDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters/{filter_id}

ModelsExpand Collapse

ItemGetResponse { 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 { 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 { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

Advanced TCP ProtectionSYN ProtectionRules

List all SYN Protection rules.

client.DDoSProtection.advancedTCPProtection.synProtection.rules.list(RuleListParams { account_id, direction, order, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<RuleListResponse { id, burst_sensitivity, created_on, 6 more } >

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

Create SYN Protection rule.

client.DDoSProtection.advancedTCPProtection.synProtection.rules.create(RuleCreateParams { account_id, burst_sensitivity, mode, 4 more } params, RequestOptionsoptions?): RuleCreateResponse { id, burst_sensitivity, created_on, 6 more }

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

Delete all SYN Protection rules.

client.DDoSProtection.advancedTCPProtection.synProtection.rules.bulkDelete(RuleBulkDeleteParams { account_id } params, RequestOptionsoptions?): RuleBulkDeleteResponse { errors, messages, success }

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

ModelsExpand Collapse

RuleListResponse { 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 { 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 { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

Advanced TCP ProtectionSYN ProtectionRulesItems

Get SYN Protection rule.

client.DDoSProtection.advancedTCPProtection.synProtection.rules.items.get(stringruleId, ItemGetParams { account_id } params, RequestOptionsoptions?): ItemGetResponse { id, burst_sensitivity, created_on, 6 more }

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

Update SYN Protection rule.

client.DDoSProtection.advancedTCPProtection.synProtection.rules.items.edit(stringruleId, ItemEditParams { account_id, burst_sensitivity, mitigation_type, 2 more } params, RequestOptionsoptions?): ItemEditResponse { id, burst_sensitivity, created_on, 6 more }

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

Delete SYN Protection rule.

client.DDoSProtection.advancedTCPProtection.synProtection.rules.items.delete(stringruleId, ItemDeleteParams { account_id } params, RequestOptionsoptions?): ItemDeleteResponse { errors, messages, success }

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

ModelsExpand Collapse

ItemGetResponse { 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 { 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 { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

Advanced TCP ProtectionTCP Flow Protection

Advanced TCP ProtectionTCP Flow ProtectionFilters

List all TCP Flow Protection filters.

client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.filters.list(FilterListParams { account_id, direction, mode, 3 more } params, RequestOptionsoptions?): V4PagePaginationArray<FilterListResponse { id, created_on, expression, 2 more } >

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

Create a TCP Flow Protection filter.

client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.filters.create(FilterCreateParams { account_id, expression, mode } params, RequestOptionsoptions?): FilterCreateResponse { id, created_on, expression, 2 more }

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

Delete all TCP Flow Protection filters.

client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.filters.bulkDelete(FilterBulkDeleteParams { account_id } params, RequestOptionsoptions?): FilterBulkDeleteResponse { errors, messages, success }

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

ModelsExpand Collapse

FilterListResponse { 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 { 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 { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

Advanced TCP ProtectionTCP Flow ProtectionFiltersItems

Get TCP Flow Protection filter.

client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.filters.items.get(stringfilterId, ItemGetParams { account_id } params, RequestOptionsoptions?): ItemGetResponse { id, created_on, expression, 2 more }

GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters/{filter_id}

Update TCP Flow Protection filter.

client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.filters.items.edit(stringfilterId, ItemEditParams { account_id, expression, mode } params, RequestOptionsoptions?): ItemEditResponse { id, created_on, expression, 2 more }

PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters/{filter_id}

Delete TCP Flow Protection filter.

client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.filters.items.delete(stringfilterId, ItemDeleteParams { account_id } params, RequestOptionsoptions?): ItemDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters/{filter_id}

ModelsExpand Collapse

ItemGetResponse { 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 { 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 { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

Advanced TCP ProtectionTCP Flow ProtectionRules

List all TCP Flow Protection rules.

client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.rules.list(RuleListParams { account_id, direction, order, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<RuleListResponse { id, burst_sensitivity, created_on, 5 more } >

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

Create TCP Flow Protection rule.

client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.rules.create(RuleCreateParams { account_id, burst_sensitivity, mode, 3 more } params, RequestOptionsoptions?): RuleCreateResponse { id, burst_sensitivity, created_on, 5 more }

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

Delete all TCP Flow Protection rules.

client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.rules.bulkDelete(RuleBulkDeleteParams { account_id } params, RequestOptionsoptions?): RuleBulkDeleteResponse { errors, messages, success }

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

ModelsExpand Collapse

RuleListResponse { 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 { 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 { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

Advanced TCP ProtectionTCP Flow ProtectionRulesItems

Get TCP Flow Protection rule.

client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.rules.items.get(stringruleId, ItemGetParams { account_id } params, RequestOptionsoptions?): ItemGetResponse { id, burst_sensitivity, created_on, 5 more }

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

Update TCP Flow Protection rule.

client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.rules.items.edit(stringruleId, ItemEditParams { account_id, burst_sensitivity, mode, rate_sensitivity } params, RequestOptionsoptions?): ItemEditResponse { id, burst_sensitivity, created_on, 5 more }

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

Delete TCP Flow Protection rule.

client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.rules.items.delete(stringruleId, ItemDeleteParams { account_id } params, RequestOptionsoptions?): ItemDeleteResponse { errors, messages, success }

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

ModelsExpand Collapse

ItemGetResponse { 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 { 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 { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

Advanced TCP ProtectionStatus

Get protection status.

client.DDoSProtection.advancedTCPProtection.status.get(StatusGetParams { account_id } params, RequestOptionsoptions?): StatusGetResponse { enabled }

GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_protection_status

Update protection status.

client.DDoSProtection.advancedTCPProtection.status.edit(StatusEditParams { account_id, enabled } params, RequestOptionsoptions?): StatusEditResponse { enabled }

PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_protection_status

ModelsExpand Collapse

StatusGetResponse { enabled }

enabled: boolean

StatusEditResponse { enabled }

enabled: boolean