POST
/v2/reserved_ipsCreate a reserved IP
Creates a reserved IP and either assigns it to a Droplet or reserves it to a region. Provide droplet_id for a Droplet assignment, or region to reserve the address to a region; project_id can optionally associate it with a project. When you assign the address during creation, the response includes links to the Droplet and the assignment action.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
Reserved IP creation details. Choose either the Droplet assignment fields or the region reservation fields.
droplet_idintegerrequired
The ID of the Droplet that the reserved IP will be assigned to.
202Returns a `reserved_ip` object with the reserved IP's standard attributes. When you assign the address to a Droplet during creation, the response also includes links to the Droplet and the assignment action.
reserved_ipobjectoptional
linksobjectoptional
401Returned when authentication credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
Error handling
A 401 is returned when authentication credentials are invalid. A 429 is returned when the API rate limit is exceeded. A 500 is returned when a server error occurs. Provide either droplet_id or region; project_id, if provided, must be a UUID.