Volume

Update volume fields

Updates an existing volume by modifying its attributes such as the environment to which it belongs. The target environment must be in the same region as the current one. Retrieve the volume_id by calling the List volumes endpoint, and the environment_name by calling the List environments endpoint.

Detachment requirement: This operation is only permitted when the volume is not attached to a virtual machine.

State requirement: This operation requires the volume to have finished provisioning. PATCH against a volume in the creating state returns 400.

patch/core/volumes/{volume_id}

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/volumes/{volume_id}
  • Auth: API key in header api_key

Path parameters

volume_idinteger required

ID of the volume.

Request body

environment_namestring required

Name of the environment to which the volume is reassigned. The target environment must exist in the same region as the current one. Retrieve environment names by calling the List environments endpoint.

Response

Volume successfully updated.

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

updatesobject

Summary of fields that were updated.

Example response

{
  "message": "Input payload validation failed",
  "volume": {
    "id": 7613,
    "name": "example-volume",
    "environment": {
      "name": "example-environment",
      "region": "NORWAY-1"
    },
    "description": "example",
    "volume_type": "Cloud-SSD",
    "size": 10,
    "status": "creating",
    "created_at": "2026-05-06T15:18:42Z",
    "updated_at": "2026-05-06T15:18:42Z",
    "attachments": [
      {
        "id": 2058,
        "device": "/dev/disk/by-id/virtio-05ff4fce-957f-486c-b",
        "status": "ATTACHING",
        "instance_id": 1402
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.