Volume

List volumes

Returns a list of your existing volumes, providing details for each. See Shared storage volumes for more information.

get/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

Query parameters

pageinteger

Page number of results to return.

pageSizeinteger

Data Per Page

searchstring

Filter results by case-insensitive substring match against the resource name.

environmentstring

Filter Environment ID or Name

Response

Success

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

pageinteger nullable

1-indexed page number of the current result set.

page_sizeinteger nullable

Number of items per page in the current result set.

countinteger

Number of items returned in the current page.

Example response

{
  "status": true,
  "message": "Getting volumes successful",
  "count": 5,
  "volumes": [
    {
      "id": 9876,
      "name": "example-volume",
      "environment": {
        "name": "example-environment",
        "region": "NORWAY-1"
      },
      "description": "example",
      "volume_type": "Cloud-SSD",
      "size": 10,
      "status": "available",
      "created_at": "2026-05-07T09:21:55Z",
      "updated_at": "2026-05-07T09:21:55Z",
      "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.