Skip to main content
PATCH
/
storage
/
edit
/
{storage_id}
Edit a storage volume
curl --request PATCH \
  --url https://api.example.com/storage/edit/{storage_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tp_storage_name": "renamed-storage",
  "deletion_protection": true,
  "size_gb": 200
}
'
{
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
storage_id
string
required

Body

application/json

Request model for editing storage.

​
tp_storage_name
string | null

New name for the storage. Must be unique within user/org scope.

Example:

"renamed-storage"

​
deletion_protection
boolean | null

Update deletion protection setting. Set to true to protect storage from accidental deletion, or false to allow deletion. Must be disabled before storage can be destroyed.

Example:

true

​
size_gb
integer | null

New size in GB. Note: Storage can only be expanded, not shrunk. New size must be greater than current size.

Required range: x > 0
Example:

200

Response

Successful Response

Response model for edit endpoints (cluster and storage).

​
message
string
required