Volume

Create volume

Creates a volume in Hyperstack that can be attached to a virtual machine, expanding its storage capacity. Specify the volume type and custom configuration in the request body. If you install an operating system on the volume using the image_id field, it becomes a bootable volume; the size must be at least 100 GB to accommodate the OS.

post/core/volumes

Request

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

Request body

environment_namestring required

Name of the environment within which the volume is created.

namestring required

Name of the volume being created.

sizeinteger required

Size of the volume in GB. Accepts values from 1 GB to 102,400 GB (100 TB).

volume_typestring required

Type of volume being created, which determines the storage technology it uses. Call the List volume types endpoint to retrieve the available types.

descriptionstring

Optional brief description of the volume.

image_idinteger

ID of an operating system image to install on the volume. Providing an image_id creates a bootable volume; when creating a bootable volume, size must be at least 100 GB.

callback_urlstring

URL that receives action events that occur on the volume.

Response

Volume successfully created.

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

Example response

{
  "status": true,
  "message": "Volume created successfully",
  "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.