Volumes configurations

List of available configurations for volumes

When creating data volume or upsizing a volume you need to provide the desired volume size. Different cloud providers offer various configurations in different data centers. Therefore, before creating or editing a volume, you need to verify the available configurations.

Use this endpoint as a reference for available volume configurations.

To search configurations for data volumes specify isBootable: false and needed filters in parameters: provider, location, data center, volume size, volume type.

To search configurations for system volume resize specify isBootable: true and vmId. You can also set the volumeGbMin to filter configurations that have not enough size.

When you find an appropriate configuration, provide its parameters in the endpoint for creating or resizing a volume.

get/v1/volume-configs

Request

  • Base URL
    https://api.emma.ms/external
  • Auth
    HTTP bearer

Query parameters

isBootableboolean required

If the volume is bootable

vmIdinteger

ID of the virtual machine

providerIdinteger
Example:5

ID of the cloud provider

locationIdinteger
Example:6

ID of the geographic location

dataCenterIdstring
Example:aws-us-west-1

ID of the cloud provider's data center

volumeGbMininteger
Example:16

Minimum volume size of the compute instance in gigabytes

volumeType'hdd' | 'ssd' | 'ssd-plus'
Example:ssd

Volume type of the data volume

pageinteger

Page number

sizeinteger
Example:100

Query size

projectIdinteger

Unused, created for future API extention. Will be ignored if used.

Response

Successful operation

totalPagesinteger

Total number of pages available

totalElementsinteger

Total number of elements across all pages

sizeinteger

Number of elements per page

numberinteger

Current page number (0-based index)

lastboolean

Indicates if this is the last page

firstboolean

Indicates if this is the first page

numberOfElementsinteger

Number of elements on the current page

emptyboolean

Indicates if the page is empty

Example response

{
  "content": [
    {
      "providerId": 5,
      "providerName": "GCP",
      "locationId": 6,
      "locationName": "London",
      "dataCenterId": "aws-us-west-1",
      "dataCenterName": "europe-west2",
      "volumeGb": 500,
      "volumeType": "ssd",
      "cost": {
        "unit": "MONTHS",
        "currency": "EUR",
        "pricePerUnit": 5.479952
      }
    }
  ]
}

Changes

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