Skip to main content

List Flavors

GET https://infrahub-api.nexgencloud.com/v1/core/flavors

Returns a list of available GPU/CPU virtual machine hardware configurations, comprising combinations of GPUs, CPUs, RAM, and system disk. These virtual machine configurations are referred to as flavors. Optionally, include a region_name in the query string of the request to return only the flavors available in the specified region; by default a list of flavors in all regions will be returned.


Query string parameters​

region enum  optional​

Include a region name in the query string of the request to return only the flavors available in the specified region, i.e. "NORWAY-1". If no region is included in the request, flavors available in all regions will be retrieved.

Possible enum values: NORWAY-1 or CANADA-1.

See more information about regions.


Attributes​

status boolean​

Indicates the status of the request to retrieve a list of flavors. true indicates success, while false indicates error.

message string​

A message indicating the success or failure of the request to retrieve flavors.

data array​

An array containing information about flavors organized by GPU model and region.

Show child attributes
gpu string​

The GPU model name.

region_name string​

The region where the GPU configurations are available.

flavors array​

An array containing details about individual flavor hardware configurations.

Show child attributes
id integer​

The unique identifier for the flavor.

name string​

The name of the flavor.

display_name string​

The name of the flavor as it appears in Hyperstack.

region_name string​

The region where the GPU flavor is available.

cpu integer​

The number of CPU cores in the flavor.

ram number​

The amount of RAM in gigabytes for the flavor.

disk integer​

The root disk size of the GPU flavor in gigabytes.

ephemeral integer​

The ephemeral disk storage capacity for the flavor in gigabytes.

gpu string​

The GPU model name for the GPU flavor.

gpu_count integer​

The number of GPUs included in the GPU flavor.

stock_available boolean​

Indicates whether the GPU flavor is currently in stock. true indicates that stock is available.

created_at date-time​

The timestamp when the flavor was created.

Example request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/core/flavors" \
  -H "accept: application/json"\
  -H "api_key: YOUR API KEY"
Response
{
  "status": true,
  "message": "Getting flavors successful",
  "data": [
    {
      "gpu": "H100-80G-PCIe",
      "region_name": "CANADA-1",
      "flavors": [
        {
          "id": 95,
          "name": "n3-H100x1",
          "display_name": null,
          "region_name": "CANADA-1",
          "cpu": 28,
          "ram": 180.0,
          "disk": 100,
          "ephemeral": 750,
          "gpu": "H100-80G-PCIe",
          "gpu_count": 1,
          "stock_available": true,
          "created_at": "2024-04-18T15:19:56"
        },
        {...}
      ]
    }
  ]
}

Returns​

This response indicates that the list of available GPU configurations has been retrieved successfully. The flavor name that meets your GPU configuration needs, will be used in the flavor_name field within the body of the request to create a new virtual machine using the POST /core/virtual-machines endpoint.

The n3-H100x1 flavor returned in this response is configured with 1x H100 GPUs, 28 CPU cores, 180.0 GB RAM, 100 GB of root disk capacity, and 750 GB of ephemeral disk capacity.

note

In this example only one flavor is displayed; n3-H100x1. Using the GET /core/flavors endpoint will return an array of all available flavors.


Back to top​