Volumes configurations

List of available configurations for system volumes

When upsizing a system volume you need to provide the desired volume size and verify it matches the virtual machine requirements.

Use this endpoint as a reference for available configurations for system volumes. You can search the available configurations by different parameters (virtual machine id, volume size, volume type).

When you find an appropriate configuration, provide its parameters in the endpoint for editing a system volume.

Note: To retrieve available configurations for DigitalOcean system volumes, use the GET v1/vms-configs method

get/v1/system-volumes-configs

Request

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

Query parameters

attachedToIdinteger

ID of the linked instance

volumeGbMininteger
Example:16

Minimum volume size of the compute instance in gigabytes

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

Volume type of the compute instance

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.