DigitalOcean API (unofficial showcase)
POST/v2/reserved_ipv6/{reserved_ipv6}/actions

Trigger a reserved IPv6 action

Triggers an action on a reserved IPv6 address to assign it to a Droplet or unassign it. Set type to assign or unassign, and include droplet_id when assigning the address. A 201 response returns the created action object.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
reserved_ipv6stringrequired
The reserved IPv6 address to perform the action on. Must be a valid IPv6 address.

Optional action payload specifying the operation to perform on the reserved IPv6 address.

typestringrequired
The type of action to initiate for the reserved IPv6.
Allowed:assignunassign

6 status codes
201Returns the created action object with the standard reserved IP action attributes.
actionobjectoptional
401Returned when authentication fails because the 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.
404Returned when the reserved IPv6 resource is not found.
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 fails, a 404 when the reserved IPv6 resource is not found, a 429 when the API rate limit is exceeded, and a 500 when a server error occurs. type must be assign or unassign; include droplet_id when assigning the address. The reserved_ipv6 path parameter must be a valid IPv6 address identifying a reserved IPv6 resource.