List Volumes
GET https://infrahub-api.nexgencloud.com/v1/core/volumes
Returns a list of your existing volumes, providing details for each. For more information on volumes, click here.
Query string parameters
search string or integer optional
Search for the name or ID of the volume to retrieve it.
page integer optional
The page number to retrieve volumes from.
pageSize integer optional
Specify the number of volumes to return per page.
Attributes
status boolean
Indicates the success or failure of the operation, true indicates success.
message string
A message confirming the status of the request to retrieve a list of existing volumes.
volumes array of objects
An array containing volumes objects each containing details about a volume.
Example request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/core/volumes" \
-H "accept: application/json"\
-H "api_key: YOUR API KEY"
Response
{
"status": true,
"message": "string",
"volumes": [
{
"id": 0,
"name": "string",
"environment": {
"name": "string"
},
"description": "string",
"volume_type": "string",
"size": "string",
"status": "string",
"bootable": false,
"image_id": 0,
"callback_url": "string",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_at": "1970-01-01T00:00:00.000Z"
}
]
}
Returns
The response will provide the status of the request along with volumes objects containing details about your volumes. To learn more about the attributes of the volumes object, click here.