Skip to main content

List Regions

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

Lists the currently available regions, each representing a distinct geographic location housing a data center. For additional information on regions, click here.


Parameters​

No parameters.


Attributes of the Regions object​

status boolean​

Indicates the success or failure of the operation. In this case, it is set to true, indicating that the regions have been retrieved successfully.

message string​

A message confirming the successful retrieval of regions.

regions array of objects​

An array of regions objects containing details about the available regions.

Show child attributes
description string​

Description of the region.

id integer​

Unique identifier for the region.

name string​

The name of the region e.g. "NORWAY-1", which includes the country it is located in, "NORWAY", and the unique identifier, "1".

green_status string​

The sustainability status of the region, indicating whether it operates on 100% sustainable energy.

Possible values:​
  • GREEN: The region runs entirely on sustainable energy.
  • PARTIALLY_GREEN: The region uses a mix of sustainable and non-sustainable energy sources.
  • NOT_GREEN: The region does not primarily rely on sustainable energy.
Example request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/core/regions" \
 -H "accept: application/json"\
 -H "api_key: YOUR API KEY"
Response
  {
    "status": true,
    "message": "Getting regions successful.",
    "regions": [
      {
        "description": null,
          "id": 1,
          "name": "NORWAY-1",
          "green_status": "GREEN"
      },
    {
      "description": null,
      "id": 2,
      "name": "CANADA-1",
      "green_status": "GREEN"
    }
  ]
}

Returns​

This response indicates that the retrieval of the list of regions has been successful. The regions "NORWAY-1" and "CANADA-1" were returned the response.

If there are multiple regions within a country, and they have different unique identifiers, e.g., "NORWAY-1" and "NORWAY-2", these are physically separate regions, that may be in the same data center or in different data centers within Norway.


Back to top​