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.

ddos_protection.advanced_tcp_protection.syn_protection.filters.list(FilterListParams**kwargs) -> SyncV4PagePaginationArray[FilterListResponse]

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

Create a SYN Protection filter.

ddos_protection.advanced_tcp_protection.syn_protection.filters.create(FilterCreateParams**kwargs) -> FilterCreateResponse

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

Delete all SYN Protection filters.

ddos_protection.advanced_tcp_protection.syn_protection.filters.bulk_delete(FilterBulkDeleteParams**kwargs) -> FilterBulkDeleteResponse

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

ModelsExpand Collapse

class FilterListResponse: …

id: str

The unique ID of the expression filter.

created_on: datetime

The creation timestamp of the expression filter.

formatdate-time

expression: str

The filter expression.

mode: str

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

modified_on: datetime

The last modification timestamp of the expression filter.

formatdate-time

class FilterCreateResponse: …

id: str

The unique ID of the expression filter.

created_on: datetime

The creation timestamp of the expression filter.

formatdate-time

expression: str

The filter expression.

mode: str

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

modified_on: datetime

The last modification timestamp of the expression filter.

formatdate-time

class FilterBulkDeleteResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.

SYN ProtectionFiltersItems

Get SYN Protection filter.

ddos_protection.advanced_tcp_protection.syn_protection.filters.items.get(strfilter_id, ItemGetParams**kwargs) -> ItemGetResponse

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

Update SYN Protection filter.

ddos_protection.advanced_tcp_protection.syn_protection.filters.items.edit(strfilter_id, ItemEditParams**kwargs) -> ItemEditResponse

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

Delete SYN Protection filter.

ddos_protection.advanced_tcp_protection.syn_protection.filters.items.delete(strfilter_id, ItemDeleteParams**kwargs) -> ItemDeleteResponse

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

ModelsExpand Collapse

class ItemGetResponse: …

id: str

The unique ID of the expression filter.

created_on: datetime

The creation timestamp of the expression filter.

formatdate-time

expression: str

The filter expression.

mode: str

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

modified_on: datetime

The last modification timestamp of the expression filter.

formatdate-time

class ItemEditResponse: …

id: str

The unique ID of the expression filter.

created_on: datetime

The creation timestamp of the expression filter.

formatdate-time

expression: str

The filter expression.

mode: str

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

modified_on: datetime

The last modification timestamp of the expression filter.

formatdate-time

class ItemDeleteResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.

SYN ProtectionRules

List all SYN Protection rules.

ddos_protection.advanced_tcp_protection.syn_protection.rules.list(RuleListParams**kwargs) -> SyncV4PagePaginationArray[RuleListResponse]

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

Create SYN Protection rule.

ddos_protection.advanced_tcp_protection.syn_protection.rules.create(RuleCreateParams**kwargs) -> RuleCreateResponse

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

Delete all SYN Protection rules.

ddos_protection.advanced_tcp_protection.syn_protection.rules.bulk_delete(RuleBulkDeleteParams**kwargs) -> RuleBulkDeleteResponse

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

ModelsExpand Collapse

class RuleListResponse: …

id: str

The unique ID of the SYN Protection rule.

burst_sensitivity: str

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

created_on: datetime

The creation timestamp of the SYN Protection rule.

formatdate-time

mitigation_type: str

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

mode: str

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

modified_on: datetime

The last modification timestamp of the SYN Protection rule.

formatdate-time

name: str

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: str

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

scope: str

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

class RuleCreateResponse: …

id: str

The unique ID of the SYN Protection rule.

burst_sensitivity: str

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

created_on: datetime

The creation timestamp of the SYN Protection rule.

formatdate-time

mitigation_type: str

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

mode: str

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

modified_on: datetime

The last modification timestamp of the SYN Protection rule.

formatdate-time

name: str

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: str

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

scope: str

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

class RuleBulkDeleteResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.

SYN ProtectionRulesItems

Get SYN Protection rule.

ddos_protection.advanced_tcp_protection.syn_protection.rules.items.get(strrule_id, ItemGetParams**kwargs) -> ItemGetResponse

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

Update SYN Protection rule.

ddos_protection.advanced_tcp_protection.syn_protection.rules.items.edit(strrule_id, ItemEditParams**kwargs) -> ItemEditResponse

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

Delete SYN Protection rule.

ddos_protection.advanced_tcp_protection.syn_protection.rules.items.delete(strrule_id, ItemDeleteParams**kwargs) -> ItemDeleteResponse

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

ModelsExpand Collapse

class ItemGetResponse: …

id: str

The unique ID of the SYN Protection rule.

burst_sensitivity: str

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

created_on: datetime

The creation timestamp of the SYN Protection rule.

formatdate-time

mitigation_type: str

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

mode: str

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

modified_on: datetime

The last modification timestamp of the SYN Protection rule.

formatdate-time

name: str

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: str

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

scope: str

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

class ItemEditResponse: …

id: str

The unique ID of the SYN Protection rule.

burst_sensitivity: str

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

created_on: datetime

The creation timestamp of the SYN Protection rule.

formatdate-time

mitigation_type: str

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

mode: str

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

modified_on: datetime

The last modification timestamp of the SYN Protection rule.

formatdate-time

name: str

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: str

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

scope: str

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

class ItemDeleteResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.