List networks

GET 
/v1/networks

Get a paginated list of networks.

note

Currently, there is a limit of one network per Defined Networking account.

Token scope required: networks:list

Request

Query Parameters

includeCounts boolean
If true, return count of total records and current page start and count in metadata
Default value: false
cursor string
Cursor value at which to start the results, provided in nextCursor or prevCursor of a prior request
Example: bmV4dA.eyJsb2dzLmNyZQ5iIiwiX3ZhbHVlIjo9In19
pageSize integer
Possible values: <= 500
Number of records to return in each page
Default value: 25

Responses

200

Successful operation

application/json

Schema

Schema

data

object[]

Array [

id string

cidr ipv4/cidr

organizationID string

signingCAID string

The ID of the Certificate Authority being used.

createdAt date-time

name string

Default value: Network1

lighthousesAsRelays boolean

]

metadata

object

totalCount integer

The total number of resources existing in the account

hasNextPage boolean

Is there a page of data that can be fetched using the nextCursor?

hasPrevPage boolean

Is there a page of data that can be fetched using the prevCursor?

nextCursor string

An opaque string that can be used to fetch the next page of results. Not provided if result set is empty.

prevCursor string

An opaque string that can be used to fetch the next page of results. Not provided if result set is empty.

page

object

count integerrequired

The number of results returned in the response.

start integerrequired

The zero-based index of the first result within the overall list. For example, the first page will have a start of 0. If 25 results are fetched, and the nextCursor used to fetch a new page of results, the second request's start will be 25.

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "cidr": "string",
      "organizationID": "string",
      "signingCAID": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "name": "Network1",
      "lighthousesAsRelays": true
    }
  ],
  "metadata": {
    "totalCount": 0,
    "hasNextPage": true,
    "hasPrevPage": true,
    "nextCursor": "string",
    "prevCursor": "string",
    "page": {
      "count": 0,
      "start": 0
    }
  }
}

noParams

When includeCounts parameter is not set to true

{
  "data": [
    {
      "cidr": "100.100.0.0/22",
      "id": "network-ZJOW3QUQUX5ZAVPVYRHDQUAEIY",
      "organizationID": "org-F63A24JGCLJV3ZEUTLCBISGETA",
      "signingCAID": "ca-TRJSVAAAPJXTOICJMG2KZBKQEE",
      "name": "Network1",
      "lighthousesAsRelays": false,
      "createdAt": "2023-02-14T20:34:59Z"
    }
  ],
  "metadata": {
    "hasNextPage": true,
    "hasPrevPage": true,
    "nextCursor": "bmV4dA.bHVlIjoieGJVS0UvYkRjQmZsY1pUbGJCc",
    "prevCursor": "cHJldg.SI6ImIiLCJfdmFsdWUiOiI0dDVuREQreU"
  }
}

includeCounts

Metadata returned when including request params for includeCounts=true, pageSize=1, and cursor="somevalue".

{
  "data": [
    {
      "cidr": "100.100.0.0/22",
      "id": "network-ZJOW3QUQUX5ZAVPVYRHDQUAEIY",
      "organizationID": "org-F63A24JGCLJV3ZEUTLCBISGETA",
      "signingCAID": "ca-TRJSVAAAPJXTOICJMG2KZBKQEE",
      "name": "Network1",
      "lighthousesAsRelays": false,
      "createdAt": "2023-02-14T20:34:59Z"
    }
  ],
  "metadata": {
    "totalCount": 500,
    "hasNextPage": true,
    "hasPrevPage": true,
    "nextCursor": "bmV4dA.bHVlIjoieGJVS0UvYkRjQmZsY1pUbGJCc",
    "prevCursor": "cHJldg.SI6ImIiLCJfdmFsdWUiOiI0dDVuREQreU",
    "page": {
      "count": 1,
      "start": 5
    }
  }
}

Loading...