Layerbeat

Rename a disk

PATCH
/v1/volumes/{id}

Changes a disk's display name. The mount folder chosen at purchase does not change.

Access: API key: vm:write · Session: developer, admin or owner.

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token>. A token is an API key (lb_live_…, scoped, for programs) or a session (lb_sess_…, from signup or login, for people). See Authentication above.

Path Parameters

id*string

The resource id.

Header Parameters

X-Org-ID?string

Sessions only: act on this organization (you must be a member). Default: your first organization.

Request Body

application/json
  1. body
name*string
Match^[a-z0-9][a-z0-9-]{0,39}$

Response Body

Renamed disk

application/json
  1. response

A Premium disk. It is billed on its own and keeps its data when detached.

id*string
name*string
status*string

creating, available (unattached), attaching, attached, detaching, deleting, deleted, expired (renew soon, data is erased after a short grace period), released (erased by our provider), failed (never bought) or unknown (purchase under review; credit reserved, not charged).

Value in"creating""available""attaching""attached""detaching""deleting""deleted""expired""released""failed""unknown"
type*string

premium or ssd (faster).

Value in"premium""ssd"
region*string
zone*string

Disks attach only to servers in the same zone. Empty while the zone of a server that is still being created is unknown.

size_gb*integer
server*|null
mount_path*string

Folder inside the server where the disk is mounted, /mnt/<name> on Linux and C:\mnt\<name> (NTFS) on Windows.

mounted*boolean
term_months*integer

Term of the original purchase.

billing*
price_per_gb_month*

The price per GB per month this disk was bought at. Renewals use it.

expires_at*|
Formatdate-time
note*|

The latest problem or instruction, for example why a disk was not mounted automatically.

created_at*string
Formatdate-time
deleted_at*|
Formatdate-time
curl -X PATCH 'https://layerbeat.com/v1/volumes/string' \  -H 'Content-Type: application/json' \  -d '{  "name": "backups"}'
{  "id": "vol_k3q9w2m7c4x8z5t6v1b0n2h4ra",  "name": "backups",  "status": "available",  "type": "premium",  "region": "sgp",  "zone": "sgp-1",  "size_gb": 50,  "server": null,  "mount_path": "/mnt/data",  "mounted": false,  "term_months": 1,  "billing": {    "currency": "USD",    "amount": "3.89"  },  "price_per_gb_month": {    "USD": "0.07770",    "IDR": "1384"  },  "expires_at": "2026-11-10T10:00:00Z",  "note": null,  "created_at": "2026-10-10T10:00:00Z",  "deleted_at": null}