API Reference

Katapult Core API

Resources & Endpoints

Get virtual machine network interface by network

Return information about a virtual machine network interface for a specific network.

GET
https://api.katapult.io/core/v1/virtual_machines/{virtual_machine}/networks/{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 Required

The virtual machine to find the network interface for

 VirtualMachine Lookup None

network Required

The network to find the network interface for

 Network Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

interface_not_found

An interface could not be found for the specified network

 404 Not Found

network_not_found

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

 404 Not Found

object_in_trash

The object found is in the trash and therefore cannot be manipulated through the API. It should be restored in order to run this operation.

 406 Not Acceptable

virtual_machine_not_found

No virtual machine 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
        } ]
    }
}