Skip to content
Cloudflare API
Start here
API Reference
DDoS Protection
Advanced TCP Protection

Allowlist

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.

AllowlistItems

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.