bucket delete
Permanently destroy a bucket, its files and its keys.
Deleting a bucket removes every file and key, and it cannot be undone. The bucket leaves the list at once. Its files and keys can keep answering for some minutes. Applications holding a key are not updated, so move them off first.
Like every deletion it never prompts. It stops, hands back the exact command that would proceed, and leaves the decision to whoever is allowed to make it. The bucket's own name has to be typed again.
Usage
outplane bucket delete <BUCKET> [flags]Arguments
| Argument | Type | Description |
|---|---|---|
BUCKET | string | The bucket's name or id, not its bucketName. Required. |
Flags
| Flag | Type | Description |
|---|---|---|
-y, --yes | bool | Acknowledge the deletion. Not sufficient on its own. |
--confirm-name | string | The bucket's name, typed again. |
The global flags apply as well.
Output
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | What the platform calls it, unique in the team. |
bucketName | string | The name S3 clients use. It carries a suffix, so it differs from name. |
public | bool | The setting last accepted: whether anyone with a file's link can read it. A change takes minutes to reach every request. Listing stays off either way. |
endpoint | string | The S3 endpoint. Clients need virtual-hosted addressing; path-style requests fail. |
region | string | The region clients sign with, always auto. |
url | string | The bucket's own address. It serves a file without a signature only when the bucket is public, and after a change to private it can keep doing so for some minutes. |
createdAt | string | null | RFC 3339, UTC. |
changed | bool | True only when it was destroyed. |
Examples
See what would be destroyed
outplane bucket delete uploads --dry-runThe confirmed form, which a human approves
outplane bucket delete uploads --yes --confirm-name uploadsCheck what the name resolves to
outplane bucket delete uploads --dry-run --json{
"changed": false,
"name": "uploads",
"public": false
}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.
- Irreversible. Every file and every key goes, and there is no snapshot and no retention window.
- The bucket leaves
bucket listat once while the deletion finishes in the background, so its files and keys can keep answering for some minutes. - Applications holding a key are not updated.
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, bucket.confirm_name_mismatch, bucket.not_found, usage.missing_argument, usage.empty_argument, context.no_team. Branch on that, or on the exit status. The message is prose and changes.