v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB

Networks

List all Interfaces for a Network.

get/networks/{id}/network_interfaces

Path parameters

idstring uuid required

Example:6a09cdc3-8948-47f0-aa62-74ac943d6c58

Identifies the resource.

Query parameters

namestring

The interface name to filter on.

typestring

The interface type to filter on.

status'created' | 'provisioning' | 'provisioned' | 'deleting'

The current status of the interface deployment.

Consolidated filter parameter (deepObject style). Originally: filter[name], filter[type], filter[status]

{
  "name": "test interface",
  "type": "wireguard_interface",
  "status": "provisioned"
}

page[number]integer

page[size]integer

Response

Successful response

Example response

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "network_interface",
      "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
  }
}