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.

ddos_protection.advanced_tcp_protection.allowlist.list(AllowlistListParams**kwargs) -> SyncV4PagePaginationArray[AllowlistListResponse]

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

Create allowlist prefix.

ddos_protection.advanced_tcp_protection.allowlist.create(AllowlistCreateParams**kwargs) -> AllowlistCreateResponse

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

Delete all allowlist prefixes.

ddos_protection.advanced_tcp_protection.allowlist.bulk_delete(AllowlistBulkDeleteParams**kwargs) -> AllowlistBulkDeleteResponse

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

ModelsExpand Collapse

class AllowlistListResponse: …

id: str

The unique ID of the allowlist prefix.

comment: str

An optional comment describing the allowlist prefix.

created_on: datetime

The creation timestamp of the allowlist prefix.

formatdate-time

enabled: bool

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

modified_on: datetime

The last modification timestamp of the allowlist prefix.

formatdate-time

prefix: str

The allowlist prefix in CIDR format.

class AllowlistCreateResponse: …

id: str

The unique ID of the allowlist prefix.

comment: str

An optional comment describing the allowlist prefix.

created_on: datetime

The creation timestamp of the allowlist prefix.

formatdate-time

enabled: bool

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

modified_on: datetime

The last modification timestamp of the allowlist prefix.

formatdate-time

prefix: str

The allowlist prefix in CIDR format.

class AllowlistBulkDeleteResponse: …

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.

Advanced TCP ProtectionAllowlistItems

Get allowlist prefix.

ddos_protection.advanced_tcp_protection.allowlist.items.get(strprefix_id, ItemGetParams**kwargs) -> ItemGetResponse

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

Update allowlist prefix.

ddos_protection.advanced_tcp_protection.allowlist.items.edit(strprefix_id, ItemEditParams**kwargs) -> ItemEditResponse

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

Delete allowlist prefix.

ddos_protection.advanced_tcp_protection.allowlist.items.delete(strprefix_id, ItemDeleteParams**kwargs) -> ItemDeleteResponse

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

ModelsExpand Collapse

class ItemGetResponse: …

id: str

The unique ID of the allowlist prefix.

comment: str

An optional comment describing the allowlist prefix.

created_on: datetime

The creation timestamp of the allowlist prefix.

formatdate-time

enabled: bool

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

modified_on: datetime

The last modification timestamp of the allowlist prefix.

formatdate-time

prefix: str

The allowlist prefix in CIDR format.

class ItemEditResponse: …

id: str

The unique ID of the allowlist prefix.

comment: str

An optional comment describing the allowlist prefix.

created_on: datetime

The creation timestamp of the allowlist prefix.

formatdate-time

enabled: bool

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

modified_on: datetime

The last modification timestamp of the allowlist prefix.

formatdate-time

prefix: str

The allowlist prefix in CIDR format.

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.

Advanced TCP ProtectionPrefixes

List all prefixes.

ddos_protection.advanced_tcp_protection.prefixes.list(PrefixListParams**kwargs) -> SyncV4PagePaginationArray[PrefixListResponse]

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

Create prefix.

ddos_protection.advanced_tcp_protection.prefixes.create(PrefixCreateParams**kwargs) -> PrefixCreateResponse

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

Delete all prefixes.

ddos_protection.advanced_tcp_protection.prefixes.bulk_delete(PrefixBulkDeleteParams**kwargs) -> PrefixBulkDeleteResponse

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

Create multiple prefixes.

ddos_protection.advanced_tcp_protection.prefixes.bulk_create(PrefixBulkCreateParams**kwargs) -> SyncSinglePage[PrefixBulkCreateResponse]

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

ModelsExpand Collapse

class PrefixListResponse: …

id: str

The unique ID of the prefix.

comment: str

A comment describing the prefix.

created_on: datetime

The creation timestamp of the prefix.

formatdate-time

excluded: bool

Whether to exclude the prefix from protection.

modified_on: datetime

The last modification timestamp of the prefix.

formatdate-time

prefix: str

The prefix in CIDR format.

class PrefixCreateResponse: …

id: str

The unique ID of the prefix.

comment: str

A comment describing the prefix.

created_on: datetime

The creation timestamp of the prefix.

formatdate-time

excluded: bool

Whether to exclude the prefix from protection.

modified_on: datetime

The last modification timestamp of the prefix.

formatdate-time

prefix: str

The prefix in CIDR format.

class PrefixBulkDeleteResponse: …

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.

class PrefixBulkCreateResponse: …

id: str

The unique ID of the prefix.

comment: str

A comment describing the prefix.

created_on: datetime

The creation timestamp of the prefix.

formatdate-time

excluded: bool

Whether to exclude the prefix from protection.

modified_on: datetime

The last modification timestamp of the prefix.

formatdate-time

prefix: str

The prefix in CIDR format.

Advanced TCP ProtectionPrefixesItems

Get prefix.

ddos_protection.advanced_tcp_protection.prefixes.items.get(strprefix_id, ItemGetParams**kwargs) -> ItemGetResponse

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

Update prefix.

ddos_protection.advanced_tcp_protection.prefixes.items.edit(strprefix_id, ItemEditParams**kwargs) -> ItemEditResponse

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

Delete prefix.

ddos_protection.advanced_tcp_protection.prefixes.items.delete(strprefix_id, ItemDeleteParams**kwargs) -> ItemDeleteResponse

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

ModelsExpand Collapse

class ItemGetResponse: …

id: str

The unique ID of the prefix.

comment: str

A comment describing the prefix.

created_on: datetime

The creation timestamp of the prefix.

formatdate-time

excluded: bool

Whether to exclude the prefix from protection.

modified_on: datetime

The last modification timestamp of the prefix.

formatdate-time

prefix: str

The prefix in CIDR format.

class ItemEditResponse: …

id: str

The unique ID of the prefix.

comment: str

A comment describing the prefix.

created_on: datetime

The creation timestamp of the prefix.

formatdate-time

excluded: bool

Whether to exclude the prefix from protection.

modified_on: datetime

The last modification timestamp of the prefix.

formatdate-time

prefix: str

The prefix in CIDR format.

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.

Advanced TCP ProtectionSYN Protection

Advanced TCP ProtectionSYN 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.

Advanced TCP ProtectionSYN 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.

Advanced TCP ProtectionSYN 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.

Advanced TCP ProtectionSYN 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.

Advanced TCP ProtectionTCP Flow Protection

Advanced TCP ProtectionTCP 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.

Advanced TCP ProtectionTCP 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.

Advanced TCP ProtectionTCP 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.

Advanced TCP ProtectionTCP 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.

Advanced TCP ProtectionStatus

Get protection status.

ddos_protection.advanced_tcp_protection.status.get(StatusGetParams**kwargs) -> StatusGetResponse

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

Update protection status.

ddos_protection.advanced_tcp_protection.status.edit(StatusEditParams**kwargs) -> StatusEditResponse

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

ModelsExpand Collapse

class StatusGetResponse: …

enabled: bool

class StatusEditResponse: …

enabled: bool