DigitalOcean API (unofficial showcase)
POST/v2/apps/{app_id}/events/{event_id}/cancel

Cancel an autoscaling event

Cancels an in-progress autoscaling event for a specified app. Use app_id and event_id to identify the event to cancel. The response includes the event details after the cancellation request.

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

2 parameters
app_idstringrequired
The unique identifier of the app containing the autoscaling event.
event_idstringrequired
The unique identifier of the in-progress autoscaling event to cancel.

6 status codes
200Returns an object containing the event, including its ID, type, creation time, deployment details, and autoscaling details.
eventobjectoptional
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 requested 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 credentials are invalid; a 404 is returned when the app or event is not found; a 429 is returned when the API rate limit is exceeded; and a 500 is returned for a server error. The app_id path parameter and event_id path parameter identify the event to cancel.