API Reference

DDoS Protection

Advanced TCP Protection

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

TCP Flow Protection

TCP Flow ProtectionFilters

List all TCP Flow Protection filters.

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

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

Create a TCP Flow Protection filter.

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

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

Delete all TCP Flow Protection filters.

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

DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_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.

TCP Flow ProtectionFiltersItems

Get TCP Flow Protection filter.

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

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

Update TCP Flow Protection filter.

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

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

Delete TCP Flow Protection filter.

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

DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_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.

TCP Flow ProtectionRules

List all TCP Flow Protection rules.

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

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

Create TCP Flow Protection rule.

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

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

Delete all TCP Flow Protection rules.

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

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

ModelsExpand Collapse

class RuleListResponse: …

id: str

The unique ID of the TCP Flow Protection rule.

burst_sensitivity: str

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

created_on: datetime

The creation timestamp of the TCP Flow Protection rule.

formatdate-time

mode: str

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

modified_on: datetime

The last modification timestamp of the TCP Flow Protection rule.

formatdate-time

name: str

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

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

scope: str

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

class RuleCreateResponse: …

id: str

The unique ID of the TCP Flow Protection rule.

burst_sensitivity: str

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

created_on: datetime

The creation timestamp of the TCP Flow Protection rule.

formatdate-time

mode: str

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

modified_on: datetime

The last modification timestamp of the TCP Flow Protection rule.

formatdate-time

name: str

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

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

scope: str

The scope for the TCP Flow 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.

TCP Flow ProtectionRulesItems

Get TCP Flow Protection rule.

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

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

Update TCP Flow Protection rule.

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

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

Delete TCP Flow Protection rule.

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

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

ModelsExpand Collapse

class ItemGetResponse: …

id: str

The unique ID of the TCP Flow Protection rule.

burst_sensitivity: str

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

created_on: datetime

The creation timestamp of the TCP Flow Protection rule.

formatdate-time

mode: str

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

modified_on: datetime

The last modification timestamp of the TCP Flow Protection rule.

formatdate-time

name: str

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

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

scope: str

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

class ItemEditResponse: …

id: str

The unique ID of the TCP Flow Protection rule.

burst_sensitivity: str

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

created_on: datetime

The creation timestamp of the TCP Flow Protection rule.

formatdate-time

mode: str

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

modified_on: datetime

The last modification timestamp of the TCP Flow Protection rule.

formatdate-time

name: str

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

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

scope: str

The scope for the TCP Flow 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.