Delete an empty storage pool (operator-only).

DELETE

/v1/storage-pools/{poolId}

Code sample: Shell / cURL

curl --request DELETE \
  --url https://stratum.example.com/v1/storage-pools/example \
  --header 'Authorization: Bearer <token>'

• A Stratum cluster endpoint.

. Tears down the pool’s volume group and frees its disks. Refused if the pool still holds volumes, if any storage class still points at it (delete the class first), or for the install’s default pool. Cedar action storage:DeleteStoragePool.

Authorizations

• bearerAuth

Parameters

Path Parameters

poolId

required

string

The stable pool id (pool-…). pools are addressed by a surrogate id, since the same pool name can exist on multiple nodes. The id is in GET /v1/storage-pools.

Responses

202

Cross-node op accepted and recorded as an intent. Poll the intent at the Location header until state is done or error.

Media typeapplication/json

A cross-node disk/pool operation recorded by the CP leader for the owning node’s reconciler to execute against its local /dev. Poll until state is done or error.

object

id

required

Intent id (nsi-…).

string

nodeId

required

The node that executes the op (owns the physical disks).

string

op

required

string

Allowed values: create-pool extend-pool shrink-pool delete-pool wipe-disk

args

Op-specific arguments (name, disks, poolId,…).

object

key

additional properties

any

state

required

string

Allowed values: pending running done error

result

Op output on done. For create/extend/shrink: poolId, name, totalBytes, devicePaths. For delete: poolId.

object

key

additional properties

any

error

Failure detail when state is error.

string

claimedAt

string format: date-time

actor

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "op": "create-pool",
  "state": "pending"
}

Headers

Location

string

The intent poll URL.

204

Deleted (synchronous, local node).

404

Resource not found.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

>= 400 <= 599

detail

string

instance

string format: uri-reference

requestId

required

string

code

required

string

issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object

code

required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string

statement

required

Index of the statement at fault; -1 for the document as a whole.

integer

>= -1

detail

required

string

action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string

errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object

field

required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string

message

required

string

details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object

key

additional properties

any

Example

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}

409

CONFLICT — the pool still holds volumes, a storage class still points at it, or it is the install’s default pool. (It answered DISK_NOT_EMPTY before.)

UNSUPPORTED — no live driver can delete pools.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

>= 400 <= 599

detail

string

instance

string format: uri-reference

requestId

required

string

code

required

string

issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object

code

required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string

statement

required

Index of the statement at fault; -1 for the document as a whole.

integer

>= -1

detail

required

string

action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string

errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object

field

required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string

message

required

string

details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object

key

additional properties

any

Example

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}