volume
volume list
List the team's disks.
read onlyrepeatable
The team's disks, with the size of each and the application it is mounted on.
Names are not unique. Every command here also takes an id, and the id is what to store.
Usage
outplane volume list [flags]Flags
| Flag | Type | Description |
|---|---|---|
--app | string | Only the disks mounted on this application. |
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. |
Examples
Every disk in the team
outplane volume listWhat one application has mounted
outplane volume list --app checkoutFind the id to attach
outplane volume list --json --fields name,id,status{
"items": [
{
"id": "3f2b1c4e-…",
"name": "data",
"status": "detached"
}
],
"total": 1,
"truncated": false
}What to Know
- A detached disk still exists and still costs storage. Detaching is not deleting.
- Names are not enforced unique. Every command here takes an id as well, and the id is what to store.
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. |
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 app.not_found, context.no_team. Branch on that, or on the exit status. The message is prose and changes.