API Reference

Katapult Core API

Resources & Endpoints

Get addresses available for network interface

Returns a list of IP addresses that can be allocated to a specific network interface.

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

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 get IP addresses for

 Virtual Machine Network Interface Lookup None

address_version Required

The IP address version to return results for

 IPAddressVersionEnum 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.

{
    ip_addresses: [ IPAddress {
        id: String
        address: String
        reverse_dns: String
        vip: Boolean
        label: String?
        address_with_mask: String
        network: Network {
            id: String
            name: String
            permalink: String?
            data_center: DataCenter {
                id: String
                name: String
                permalink: String?
                country: Country {
                    id: String
                    name: String
                    iso_code2: String
                    iso_code3: String
                    time_zone: String?
                    eu: Boolean
                }
            }
        }
        allocation_id: String?
        allocation_type: String?
    } ]
}