Skip to main content

List all Interfaces for a Network.


List all Interfaces for a Network.


Path Parameters

    id uuidrequired

    Identifies the resource.

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[name] string

    The interface name to filter on.

    filter[type] string

    The interface type to filter on.

    filter[status] InterfaceStatus

    Possible values: [created, provisioning, provisioned, deleting]

    The interface status to filter on.


200: Successful response

default: Unexpected error

Request samples

curl -L '' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

"data": [
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": true,
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z",
"network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "test interface",
"status": "provisioned",
"region_code": "ashburn-va",
"region": {
"code": "ashburn-va",
"name": "Ashburn",
"record_type": "region"
"type": "wireguard_interface"
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25