API Reference

DDoS Protection

Advanced TCP Protection

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

SYN Protection

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

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

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

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