Skip to content

List networks

GET
/v2/networks

Get a paginated list of all networks.

Token scope required: networks:list

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
includeCounts
boolean

If true, return count of total records and current page start and count in metadata

cursor
string

Cursor value at which to start the results, provided in nextCursor or prevCursor of a prior request

Example
bmV4dA.eyJsb2dzLmNyZQ5iIiwiX3ZhbHVlIjo9In19
pageSize
integer
default: 25 <= 500

Number of records to return in each page

sortDirection
string
default: asc
Allowed values: asc desc

Order in which to return results. Each endpoint sorts on its own key (for example, hosts by name and audit logs by creation time). Matching is case-insensitive, and any value other than desc sorts ascending.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful operation

object
data
required
Array<object>
object
id
required
string
organizationID
required
string
signingCAID
required

The ID of the Certificate Authority being used.

string
name
required
string
description
required
string
cidrs
required

List of CIDR prefixes assigned to this network. IPv4-only networks have exactly one IPv4 entry. IPv6-capable networks always have an IPv6 CIDR and optionally an IPv4 CIDR.

Array<string>
certVersion
required

Certificate version used by this network. Version 2 is required for IPv6 support. Known values are 1 and 2. New values may be added, so clients should accept values not listed here.

integer
lighthousesAsRelays
required
boolean
disableManagedLighthouses
required

Whether this network has opted out of the managed lighthouse. When false, Defined Networking runs a lighthouse for the network and no lighthouse of your own is required.

boolean
curve
required

Cryptographic curve used by the network’s certificates. Known values are 25519 and P256. New values may be added, so clients should accept values not listed here.

string
hostCount
required
integer
createdAt
required
string format: date-time
metadata
required
object
totalCount

The total number of resources existing in the account. Only present when includeCounts is true.

integer
hasNextPage
required

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

boolean
hasPrevPage
required

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

boolean
nextCursor

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

string
prevCursor

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

string
page

Only present when includeCounts is true.

object
count
required

The number of results returned in the response.

integer
start
required

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.

integer
Examples

List with both IPv4-only and IPv6-capable networks

{
  "data": [
    {
      "id": "network-ZJOW3QUQUX5ZAVPVYRHDQUAEIY",
      "organizationID": "org-F63A24JGCLJV3ZEUTLCBISGETA",
      "signingCAID": "ca-TRJSVAAAPJXTOICJMG2KZBKQEE",
      "name": "Network1",
      "description": "",
      "cidrs": [
        "100.100.0.0/22",
        "fdef:c0:c0:1::/80"
      ],
      "certVersion": 2,
      "hostCount": 5,
      "lighthousesAsRelays": false,
      "disableManagedLighthouses": false,
      "curve": "25519",
      "createdAt": "2023-02-14T20:34:59Z"
    },
    {
      "id": "network-KAOWMXZHZWCVMGGFKM22XEGYLE",
      "organizationID": "org-F63A24JGCLJV3ZEUTLCBISGETA",
      "signingCAID": "ca-TRJSVAAAPJXTOICJMG2KZBKQEE",
      "name": "LegacyNet",
      "description": "",
      "cidrs": [
        "192.168.4.0/22"
      ],
      "certVersion": 1,
      "hostCount": 3,
      "lighthousesAsRelays": false,
      "disableManagedLighthouses": true,
      "curve": "25519",
      "createdAt": "2022-11-01T10:00:00Z"
    }
  ],
  "metadata": {
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

401

Section titled “401 ”

The API key is missing, invalid or expired.

object
errors
required
Array<object>
object
code
required

A static name for the error type

string
message
required

A short human readable description of the error

string
path

Describes the variable missing or malformed

string
param

The query parameter the error relates to, such as filter.targetType

string
extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object
limit

The maximum number of resources allowed

integer
limitName

The kind of resource the limit applies to

string
key
additional properties
any
Example
{
  "errors": [
    {
      "code": "ERR_UNAUTHORIZED",
      "message": "unauthorized"
    }
  ]
}

403

Section titled “403 ”

The API key lacks a required scope.

object
errors
required
Array<object>
object
code
required

A static name for the error type

string
message
required

A short human readable description of the error

string
path

Describes the variable missing or malformed

string
param

The query parameter the error relates to, such as filter.targetType

string
extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object
limit

The maximum number of resources allowed

integer
limitName

The kind of resource the limit applies to

string
key
additional properties
any
Examples

The API key lacks a required scope.

{
  "errors": [
    {
      "code": "ERR_FORBIDDEN",
      "message": "api key must support the following scopes: hosts:read"
    }
  ]
}

429

Section titled “429 ”

The organization has exceeded its API request rate limit. Retry the request after a short delay.

object
errors
required
Array<object>
object
code
required

A static name for the error type

string
message
required

A short human readable description of the error

string
path

Describes the variable missing or malformed

string
param

The query parameter the error relates to, such as filter.targetType

string
extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object
limit

The maximum number of resources allowed

integer
limitName

The kind of resource the limit applies to

string
key
additional properties
any
Example
{
  "errors": [
    {
      "code": "ERR_TOO_MANY_REQUESTS",
      "message": "too many requests"
    }
  ]
}