Skip to content
Start here

Allowlist

List all allowlist prefixes.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist
Create allowlist prefix.
POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist
Delete all allowlist prefixes.
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist
ModelsExpand Collapse
AllowlistListResponse object { 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 object { 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 object { errors, messages, success }
errors: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
messages: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
success: true

Whether the API call was successful.

AllowlistItems

Get allowlist prefix.
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id}
Update allowlist prefix.
PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id}
Delete allowlist prefix.
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id}
ModelsExpand Collapse
ItemGetResponse object { 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 object { 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 object { errors, messages, success }
errors: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
messages: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
success: true

Whether the API call was successful.