volume
volume delete
Permanently destroy a disk and its contents.
destructive--dry-run
Destroys a disk and its contents. There is no snapshot and no retention window.
An attached disk cannot be deleted. volume detach first, which is the platform
making sure no application is still using it.
Usage
outplane volume delete <VOLUME> [flags]Arguments
| Argument | Type | Description |
|---|---|---|
VOLUME | string | Volume name or id. Required. |
Flags
| Flag | Type | Description |
|---|---|---|
-y, --yes | bool | Acknowledge the deletion. Not sufficient on its own. |
--confirm-name | string | The disk's name, typed again. |
The global flags apply as well.
Output
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
sizeGb | int | 10 to 50, and fixed once created. |
status | string | One of attached, detached. |
app | string | null | The application it is mounted on. |
appId | string | null | |
mountPath | string | null | Where it appears inside the container. |
accessMode | string | Always ReadWriteOnce: one instance mounts it at a time. |
createdAt | string | null | RFC 3339, UTC. |
changed | bool | True only when it was destroyed. |
Examples
See what would be destroyed
outplane volume delete data --dry-runThe confirmed form, which a human approves
outplane volume delete data --yes --confirm-name dataCheck what the name resolves to, and what is on it
outplane volume delete data --dry-run --json{
"changed": false,
"name": "data",
"sizeGb": 10
}What to Know
- This command never prompts. Without confirmation it exits 4 and returns the command to replay in the error's confirm_command field.
- Under a detected agent harness it exits 4 even with both flags, so the approval stays with whoever is accountable for the data.
- An attached disk cannot be deleted. Detach it first, which is the platform making sure the application is not using it.
- Irreversible. There is no snapshot and no retention window.
Errors
Beyond 0 for success, this command exits with:
| Exit | Kind | Meaning |
|---|---|---|
2 | usage | Invalid arguments, unknown flag, or client-side validation failure. |
3 | auth | Not authenticated, token revoked or expired, or forbidden for this team. |
4 | confirmation_required | A destructive operation stopped. Replay the command in confirm_command. |
5 | not_found | The named resource does not exist, or is not visible to this credential. |
8 | upstream | The Out Plane API returned a server error. |
The code on the error object is one of confirmation.required, volume.confirm_name_mismatch, volume.not_found. Branch on that, or on the exit status. The message is prose and changes.