API Reference

DDoS Protection

Advanced TCP Protection

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Allowlist

List all allowlist prefixes.

client.DDoSProtection.advancedTCPProtection.allowlist.list(AllowlistListParams { account_id, direction, order, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<AllowlistListResponse { id, comment, created_on, 3 more } >

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

Create allowlist prefix.

client.DDoSProtection.advancedTCPProtection.allowlist.create(AllowlistCreateParams { account_id, comment, enabled, prefix } params, RequestOptionsoptions?): AllowlistCreateResponse { id, comment, created_on, 3 more }

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

Delete all allowlist prefixes.

client.DDoSProtection.advancedTCPProtection.allowlist.bulkDelete(AllowlistBulkDeleteParams { account_id } params, RequestOptionsoptions?): AllowlistBulkDeleteResponse { errors, messages, success }

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

ModelsExpand Collapse

AllowlistListResponse { id, comment, created_on, 3 more }

id: string

The unique ID of the allowlist prefix.

comment: string

An optional comment describing the allowlist prefix.

created_on: string

The creation timestamp of the allowlist prefix.

formatdate-time

enabled: boolean

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

modified_on: string

The last modification timestamp of the allowlist prefix.

formatdate-time

prefix: string

The allowlist prefix in CIDR format.

AllowlistCreateResponse { id, comment, created_on, 3 more }

id: string

The unique ID of the allowlist prefix.

comment: string

An optional comment describing the allowlist prefix.

created_on: string

The creation timestamp of the allowlist prefix.

formatdate-time

enabled: boolean

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

modified_on: string

The last modification timestamp of the allowlist prefix.

formatdate-time

prefix: string

The allowlist prefix in CIDR format.

AllowlistBulkDeleteResponse { 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.

AllowlistItems

Get allowlist prefix.

client.DDoSProtection.advancedTCPProtection.allowlist.items.get(stringprefixId, ItemGetParams { account_id } params, RequestOptionsoptions?): ItemGetResponse { id, comment, created_on, 3 more }

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

Update allowlist prefix.

client.DDoSProtection.advancedTCPProtection.allowlist.items.edit(stringprefixId, ItemEditParams { account_id, comment, enabled } params, RequestOptionsoptions?): ItemEditResponse { id, comment, created_on, 3 more }

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

Delete allowlist prefix.

client.DDoSProtection.advancedTCPProtection.allowlist.items.delete(stringprefixId, ItemDeleteParams { account_id } params, RequestOptionsoptions?): ItemDeleteResponse { errors, messages, success }

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

ModelsExpand Collapse

ItemGetResponse { id, comment, created_on, 3 more }

id: string

The unique ID of the allowlist prefix.

comment: string

An optional comment describing the allowlist prefix.

created_on: string

The creation timestamp of the allowlist prefix.

formatdate-time

enabled: boolean

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

modified_on: string

The last modification timestamp of the allowlist prefix.

formatdate-time

prefix: string

The allowlist prefix in CIDR format.

ItemEditResponse { id, comment, created_on, 3 more }

id: string

The unique ID of the allowlist prefix.

comment: string

An optional comment describing the allowlist prefix.

created_on: string

The creation timestamp of the allowlist prefix.

formatdate-time

enabled: boolean

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

modified_on: string

The last modification timestamp of the allowlist prefix.

formatdate-time

prefix: string

The allowlist prefix in CIDR format.

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.