List Prefixes

List all prefixes owned by the account.

application/json

Body

result

required

Any of

allOf {2}

array[object (ipam-prefixes) {13}]

allOf {2}

One of

array[object (ipam-prefixes) {13}]

object

account_id

string

common_components-schemas-identifier

read-onlyoptional

Identifier

<= 32 characters

Example:

023e105f4ecef8ad9ca31a8372d0c353

advertised

boolean | null

advertised

optional

Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.

Example:

true

advertised_modified_at

string <date-time> | null

modified_at_nullable

optional

Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.

Example:

2014-01-01T05:20:00.12345Z

approved

string

approved

optional

Approval state of the prefix (P = pending, V = active).

Example:

asn

integer | null

asn

optional

Autonomous System Number (ASN) the prefix will be advertised under.

cidr

string

cidr

optional

IP Prefix in Classless Inter-Domain Routing format.

Example:

192.0.2.0/24

created_at

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

description

string

ipam-prefixes_components-schemas-description

optional

Description of the prefix.

<= 1000 characters

Example:

Internal test prefix

string

common_components-schemas-identifier

read-onlyoptional

Identifier

<= 32 characters

Example:

023e105f4ecef8ad9ca31a8372d0c353

loa_document_id

string | null

loa_document_identifier

read-onlyoptional

Identifier for the uploaded LOA document.

<= 32 characters

Example:

d933b1530bc56c9953cf8ce166da8004

modified_at

string <date-time>

timestamp

read-onlyoptional

Example:

2014-01-01T05:20:00.12345Z

on_demand_enabled

boolean

on_demand_enabled

optional

Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.

Example:

true

on_demand_locked

boolean

on_demand_locked

optional

Whether advertisement status of the prefix is locked, meaning it cannot be changed.

Example:

false

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
            "advertised": true,
            "advertised_modified_at": "2014-01-01T05:20:00.12345Z",
            "approved": "P",
            "asn": 0,
            "cidr": "192.0.2.0/24",
            "created_at": "2014-01-01T05:20:00.12345Z",
            "description": "Internal test prefix",
            "id": "023e105f4ecef8ad9ca31a8372d0c353",
            "loa_document_id": "d933b1530bc56c9953cf8ce166da8004",
            "modified_at": "2014-01-01T05:20:00.12345Z",
            "on_demand_enabled": true,
            "on_demand_locked": false
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses