Skip to main content
POST
Create a prefix list

Authorizations

Authorization
string
header
required

Authentication is performed via an Auth0-issued JSON Web Token (JWT). Provide the token in the Authorization header with the Bearer scheme.

Body

application/json

The details of the new prefix list.

Defines the writable properties for creating or updating a prefix list.

name
string
required

A human-readable name for the prefix list.

Maximum string length: 255
Example:

"Third-Party API Endpoints"

prefixes
object[]
required

A list of prefixes (CIDR blocks). The entire list is replaced on update.

Maximum array length: 500
sites
string[]
required

A list of site IDs where this prefix list should be directly applied. The entire list of sites is replaced on update.

description
string | null

An optional description for the prefix list.

Maximum string length: 1000
Example:

"Static IPs for services we integrate with."

Response

The prefix list was created successfully.

Represents a reusable, named collection of IP addresses and CIDR blocks.

id
string
read-only

The unique identifier for the prefix list, prefixed with prfx_lst_.

Example:

"prfx_lst_0ujsswThIGTUYm2K8FjOOfxcYpw"

name
string

A human-readable name for the prefix list.

Example:

"Main Office IPs"

description
string

An optional description for the prefix list.

Example:

"Public IP ranges for the main office."

status
enum<string>
read-only

The current synchronization status of the prefix list.

Available options:
active,
syncing,
failed
Example:

"active"

sites
string[]

A list of site IDs where this prefix list is directly applied.

prefixes
object[]

The list of CIDR blocks in this prefix list.