Skip to main content

List virtual machine network interfaces

GET 

/virtual_machines/virtual_machine/network_interfaces

Returns a list of virtual machine network interfaces

Scopes

  • virtual_machines
  • virtual_machines:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

    virtual_machine[id] string

    The virtual machine to show network interfaces for.

    All 'virtual_machine[]' params are mutually exclusive, only one can be provided.

    virtual_machine[fqdn] string

    The virtual machine to show network interfaces for.

    All 'virtual_machine[]' params are mutually exclusive, only one can be provided.

    page integer

    Possible values: >= 1

    Default value: 1

    The page number to request. If not provided, the first page will be returned.

    per_page integer

    Possible values: >= 1

    Default value: 30

    The number of items to return per page. If not provided, the default value will be used.

Responses

Returns a list of virtual machine network interfaces

Schema

    pagination

    object

    required

    current_page integer

    The current page

    total_pages integernullable

    The total number of pages

    total integernullable

    The total number of items across all pages

    per_page integer

    The number of items per page

    large_set boolean

    Is this a large set and therefore the total number of records cannot be returned?

    virtual_machine_network_interfaces

    object[]

    required

    The network interfaces for this virtual machine

  • Array [

  • id string
    name string

    network

    object

    id string
    name string

    ip_addresses

    object[]

  • Array [

  • id string
    address string
  • ]

  • ]

Loading...