Networks

List all Interfaces for a Network.

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
  }
}

Changes

Changed in 4 of the 47 revisions of this API.42024

  • 8a8c40f458c51101See the full diff
    • the data/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property data/items/created_at from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/network_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/record_type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/region from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/region_code from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/status from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/updated_at from the response with the 200 status

      response-optional-property-removed

    • added Record Interface RegionOut subschema #4: NetworkInterface to the data/items/ response property allOf list for the response status 200

      response-property-all-of-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 50870cc05614111See the full diff
    • the data/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • added the optional property data/items/created_at to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/id to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/name to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/network_id to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/record_type to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/region to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/region_code to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/status to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/type to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/updated_at to the response with the 200 status

      response-optional-property-added

    • removed Record Interface RegionOut subschema #4: NetworkInterface from the data/items/ response property allOf list for the response status 200

      response-property-all-of-removed

  • a144ff96b4ac1101See the full diff
    • the data/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property data/items/created_at from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/network_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/record_type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/region from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/region_code from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/status from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/updated_at from the response with the 200 status

      response-optional-property-removed

    • added Record Interface RegionOut subschema #4: NetworkInterface to the data/items/ response property allOf list for the response status 200

      response-property-all-of-added

  • 30cb1ddce91b111See the full diff
    • the data/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • added the optional property data/items/created_at to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/id to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/name to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/network_id to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/record_type to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/region to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/region_code to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/status to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/type to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/updated_at to the response with the 200 status

      response-optional-property-added

    • removed Record Interface RegionOut subschema #4: NetworkInterface from the data/items/ response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog