Unallocate an IP address

Unallocate an IP address from its resource.

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

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 unallocate

IP Address Lookup 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

no_allocation

This IP address is not currently allocated to any object, and cannot be unallocated.

422 Unprocessable Entity

resource_does_not_support_unallocation

The resource this IP address belongs to does not allow you to unallocate it.

409 Conflict

Returned Object

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

{
}