latestOpenAPI 3.1.02026-08-23100133183.1 KB

0d66c7340876

Instances

Perform action - deprecated

post/v1/instances/action

Headers

user-agentstring required
cf-connecting-ipstring required

Request body

action'boot' | 'start' | 'shutdown' | 'delete' | 'discontinue' | 'hibernate' | 'configure_spot' | 'force_shutdown' | 'delete_stuck' | 'deploy' | 'transfer' required
volume_idsstring[]

Volume IDs to delete. Specify empty array to indicate no volumes should be deleted (previously known as "hibernate")

delete_permanentlyboolean

Delete the volumes permanently. Only applicable for delete (or discontinue) action, when volume IDs to delete are also provided.

Example request

{
  "volume_ids": [
    "ad07095b-2427-43cd-bd4c-04a01c4f8ad6"
  ]
}