API Reference

Katapult Core API

Resources & Endpoints

Update IP address

Updates the details on an IP address.

PATCH
https://api.katapult.io/core/v1/ip_addresses/{ip_address}

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

ip_address Required

The IP address to update

 IP Address Lookup None

vip

Whether or not to set this address as a VIP

 Boolean None

label

The label to give this address if setting it as a VIP

 String None

reverse_dns

The reverse DNS to set for this IP address

 String None

Potential Errors

The following errors may occur during this request.

Details HTTP status

ip_address_not_found

No IP addresses were found matching any of the criteria provided in the arguments

 404 Not Found

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

validation_error

A validation error occurred with the object that was being created/updated/deleted

 422 Unprocessable Entity

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