volume get

read onlyrepeatable

One disk: its size, its state, and where it is mounted if it is mounted at all.

Two disks sharing a name are reported as ambiguous rather than resolved to one of them.

Usage

outplane volume get <VOLUME>

Arguments

Argument	Type	Description
`VOLUME`	`string`	Volume name or id. Required.

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

Show a disk

outplane volume get data

Read where it is mounted, in a script

outplane volume get data --json --fields app,mountPath,sizeGb

{
  "app": "checkout",
  "mountPath": "/data",
  "sizeGb": 10
}

Check whether anything uses it before deleting it

outplane volume get data -o text

What to Know

There is no per-volume endpoint that takes a name, so this lists the team's disks and matches. The cost is the same as volume list.
Matching is exact, on the id first and then the name. Two disks with the same name are reported as ambiguous rather than resolved to one of them.

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 volume.not_found, volume.ambiguous, usage.missing_argument. Branch on that, or on the exit status. The message is prose and changes.