Skip to main content
GET
/
prefix-lists
/
{prefixListId}
Retrieve a prefix list
curl --request GET \
  --url https://api.altostrat.io/prefix-lists/{prefixListId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "prfx_lst_0ujsswThIGTUYm2K8FjOOfxcYpw",
  "name": "Main Office IPs",
  "description": "Public IP ranges for the main office.",
  "status": "active",
  "sites": [
    "site_12345"
  ],
  "prefixes": [
    {
      "id": "prfx_0ujsswThIGTUYm2K8FjOOfxcYpw",
      "cidr": "192.0.2.0/24",
      "description": "Main server subnet"
    }
  ]
}

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.

Path Parameters

โ€‹
prefixListId
string
required

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

Example:

"prfx_lst_0ujsswThIGTUYm2K8FjOOfxcYpw"

Response

The requested prefix list object.

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

โ€‹
id
string

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>

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.