Skip to content
Start here

Prefixes

List all prefixes.
client.DDoSProtection.advancedTCPProtection.prefixes.list(PrefixListParams { account_id, direction, order, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<PrefixListResponse { id, comment, created_on, 3 more } >
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes
Create prefix.
client.DDoSProtection.advancedTCPProtection.prefixes.create(PrefixCreateParams { account_id, comment, excluded, prefix } params, RequestOptionsoptions?): PrefixCreateResponse { id, comment, created_on, 3 more }
POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes
Delete all prefixes.
client.DDoSProtection.advancedTCPProtection.prefixes.bulkDelete(PrefixBulkDeleteParams { account_id } params, RequestOptionsoptions?): PrefixBulkDeleteResponse { errors, messages, success }
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes
Create multiple prefixes.
client.DDoSProtection.advancedTCPProtection.prefixes.bulkCreate(PrefixBulkCreateParams { account_id, body } params, RequestOptionsoptions?): SinglePage<PrefixBulkCreateResponse { id, comment, created_on, 3 more } >
POST/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/bulk
ModelsExpand Collapse
PrefixListResponse { id, comment, created_on, 3 more }
id: string

The unique ID of the prefix.

comment: string

A comment describing the prefix.

created_on: string

The creation timestamp of the prefix.

formatdate-time
excluded: boolean

Whether to exclude the prefix from protection.

modified_on: string

The last modification timestamp of the prefix.

formatdate-time
prefix: string

The prefix in CIDR format.

PrefixCreateResponse { id, comment, created_on, 3 more }
id: string

The unique ID of the prefix.

comment: string

A comment describing the prefix.

created_on: string

The creation timestamp of the prefix.

formatdate-time
excluded: boolean

Whether to exclude the prefix from protection.

modified_on: string

The last modification timestamp of the prefix.

formatdate-time
prefix: string

The prefix in CIDR format.

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

PrefixBulkCreateResponse { id, comment, created_on, 3 more }
id: string

The unique ID of the prefix.

comment: string

A comment describing the prefix.

created_on: string

The creation timestamp of the prefix.

formatdate-time
excluded: boolean

Whether to exclude the prefix from protection.

modified_on: string

The last modification timestamp of the prefix.

formatdate-time
prefix: string

The prefix in CIDR format.

PrefixesItems

Get prefix.
client.DDoSProtection.advancedTCPProtection.prefixes.items.get(stringprefixId, ItemGetParams { account_id } params, RequestOptionsoptions?): ItemGetResponse { id, comment, created_on, 3 more }
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id}
Update prefix.
client.DDoSProtection.advancedTCPProtection.prefixes.items.edit(stringprefixId, ItemEditParams { account_id, comment, excluded } params, RequestOptionsoptions?): ItemEditResponse { id, comment, created_on, 3 more }
PATCH/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id}
Delete prefix.
client.DDoSProtection.advancedTCPProtection.prefixes.items.delete(stringprefixId, ItemDeleteParams { account_id } params, RequestOptionsoptions?): ItemDeleteResponse { errors, messages, success }
DELETE/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id}
ModelsExpand Collapse
ItemGetResponse { id, comment, created_on, 3 more }
id: string

The unique ID of the prefix.

comment: string

A comment describing the prefix.

created_on: string

The creation timestamp of the prefix.

formatdate-time
excluded: boolean

Whether to exclude the prefix from protection.

modified_on: string

The last modification timestamp of the prefix.

formatdate-time
prefix: string

The prefix in CIDR format.

ItemEditResponse { id, comment, created_on, 3 more }
id: string

The unique ID of the prefix.

comment: string

A comment describing the prefix.

created_on: string

The creation timestamp of the prefix.

formatdate-time
excluded: boolean

Whether to exclude the prefix from protection.

modified_on: string

The last modification timestamp of the prefix.

formatdate-time
prefix: string

The 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.