Skip to main content
DELETE
Delete basic VM

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

basic_vm_id
string<uuid4>
required

Basic VM ID.

Example:

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

Query Parameters

all_floating_ips
boolean
default:false

Delete all floating IPs of the ports of the basic VM. By default, the API disconnects the floating IPs and keeps them. Do not send it with floating_ip_ids.

all_ports
boolean
default:false

Delete all ports of the basic VM. By default, the API detaches the ports and keeps them. Do not send it with port_ids.

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 IPs. The other floating IPs stay. Do not send it with all_floating_ips. To send more than one ID, repeat the key: ?floating_ip_ids=<id1>&floating_ip_ids=<id2>.

Example:
port_ids
string<uuid4>[]

Delete only these ports of the basic VM. The other ports stay. Do not send it with all_ports. To send more than one ID, repeat the key: ?port_ids=<id1>&port_ids=<id2>.

Example:

Response

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

resources_to_delete
BasicVmCascadeResourceSerializer · object[]
required

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

resources_to_preserve
BasicVmCascadeResourceSerializer · object[]
required

The ports and floating IPs of the basic VM 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: