List Volume Types

Retrieves a list of available volume types that can be used in the creation of a new volume.

HTTP Request

GET {API_URL}/volume-types

Query string parameters

Parameters	Requirements	Type	Description
region_id	Required	string	Include a region_id in the query string of the request to return only the volume types available in the specified region_id

Reponse Attributes

status boolean

Indicates the status of the request to retrieve a list of volume types. true signifies success, while false indicates an error.

message string

A message confirming the successful retrieval of the volume types list.

data array

An array containing the names of volume types that can be used in the volume_type field in the request to create volumes.

Each volume type specifies the following properties:

• name string: The volume type of the virtual machine.
• id string: The unique identifier for the volume type.

Example

Request

curl -X GET '{API_URL}volume-types?region_id=66c2e4c456dc2588c29ce900' \
-H 'Authorization: Bearer {API_TOKEN}' \
-H 'Content-Type: application/json'

Response

{
    "status": true,
    "message": "Getting volume types successful",
    "data": [
        {
            "name": "Cloud-SSD",
            "id": "684f80fee3c16d1858913e2a"
        }
    ]
}