API Reference

Katapult Core API

Resources & Endpoints

Get virtual machine network interface

Return information about a given virtual machine network interface.

GET
https://api.katapult.io/core/v1/virtual_machine_network_interfaces/{virtual_machine_network_interface}

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

virtual_machine_network_interface Required

The network interface to show the information for

 Virtual Machine Network Interface Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

virtual_machine_network_interface_not_found

No network interface was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    virtual_machine_network_interface: VirtualMachineNetworkInterface {
        id: String
        virtual_machine: VirtualMachine {
            id: String
            name: String
        }
        name: String
        network: Network {
            id: String
            name: String
        }
        mac_address: String
        state: String
        ip_addresses: [ IPAddress {
            id: String
            address: String
        } ]
        speed_profile: NetworkSpeedProfile {
            id: String
            name: String
            permalink: String
        }
    }
}