Skip to main content
DELETE
Delete instance

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Path Parameters

project_id
integer
required

Project ID.

Example:

1

instance_id
string<uuid4>
required

Instance ID.

Example:

"6c6aa80f-4234-4678-9abc-def012345678"

Query Parameters

all_floating_ips
boolean

Delete all associated floating IPs (default: preserve).

all_ports
boolean

Delete all attached ports (default: preserve).

all_volumes
boolean

Delete all attached volumes (default: preserve).

dry_run
boolean
default:false

Run every check of the real request and change nothing. The response has the status code and the schema of the real call, and an empty list of tasks. With false, the default, the request does the operation.

floating_ip_ids
string<uuid4>[]

Delete only these floating IP IDs (mutually exclusive with all_floating_ips).

port_ids
string<uuid4>[]

Delete only these port IDs (mutually exclusive with all_ports).

volume_ids
string<uuid4>[]

Delete only these volume IDs (mutually exclusive with all_volumes).

Response

Task IDs, and the other resources that the delete removes or keeps

resources_to_delete
InstanceCascadeResourceSerializer · object[]
required

Every resource that this request deletes: the instance, and each volume, snapshot, port and floating IP that goes with it. Sorted by type, then by id.

resources_to_preserve
InstanceCascadeResourceSerializer · object[]
required

The volumes, ports and floating IPs of the instance that stay after the delete. Sorted by type, then by id.

tasks
string[]
required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

  • GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.
Example: