Manage IP addresses. See device and project endpoints to list and create IP assignments for a particular project or device. Check out the product docs to learn more about the basic networking features.
Retrieve an ip address
/ips/{id}
Returns a single ip address if the user has access.
Unassign an ip address
/ips/{id}
Note! This call can be used to un-assign an IP assignment or delete an IP reservation. Un-assign an IP address record. Use the assignment UUID you get after attaching the IP. This will remove the relationship between an IP and the device and will make the IP address available to be assigned to another device. Delete and IP reservation. Use the reservation UUID you get after adding the IP to the project. This will permanently delete the IP block reservation from the project.
Retrieve all ip assignments
/devices/{id}/ips
Returns all ip assignments for a device.
Create a ip assignment
/devices/{id}/ips
Creates an ip assignment for a device.
Retrieve all available subnets of a particular reservation
/ips/{id}/available
Provides a list of IP resevations for a single project.
Retrieve all ip reservations
/projects/{id}/ips
Provides a list of IP resevations for a single project.
Requesting IP reservations
/projects/{id}/ips
Request more IP space for a project in order to have additional IP addresses to assign to devices. If the request is within the max quota, an IP reservation will be created. If the project will exceed its IP quota, a request will be submitted for review, and will return an IP Reservation with a state
of pending
. You can automatically have the request fail with HTTP status 422 instead of triggering the review process by providing the fail_on_approval_required
parameter set to true
in the request.
Retrieve the custom metadata of an IP Reservation or IP Assignment
/ips/{id}/customdata
Provides the custom metadata stored for this IP Reservation or IP Assignment in json format