API Reference

Katapult Core API

Resources & Endpoints

Allocate a new IP address

Add a new IP address to this organization and allocate it to a virtual machine network interface.

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

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 allocate the new IP to

 Virtual Machine Network Interface Lookup None

address_version Required

The IP address version to use for the new IP

 IPAddressVersionEnum None

Potential Errors

The following errors may occur during this request.

Details HTTP status

no_available_addresses

Our pool of addresses for that version seems to have run dry. If this issue continues, please contact support.

 503 Service Unavailable

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

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_address: 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?
    }
}