Skip to main content

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

    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

    Default value: 25

    Number of records to return in each page

Responses​

Successful operation

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.

Loading...