Skip to main content

Regions

statusboolean

Whether the request succeeded.

Example: true
messagestring

Human-readable description of the result.

Example: Getting regions successful.
regions object[]

Regions where the resource is available.

  • Array [
  • idinteger

    Unique numeric identifier.

    Example: 9876
    namestring

    Resource name.

    Example: NORWAY-1
    countrystring

    ISO 3166-1 alpha-2 country code of the region.

    Example: NO
    descriptionstringnullable

    Human-readable description of the resource.

    green_statusstring

    Indicator of how much of the region's capacity is running on green energy.

    Possible values: [GREEN, PARTIALLY_GREEN, NOT_GREEN]

    Example: GREEN
    features object

    Optional feature flags applicable to the resource.

    object
  • ]
  • Regions
    {
    "status": true,
    "message": "Getting regions successful.",
    "regions": [
    {
    "id": 9876,
    "name": "NORWAY-1",
    "country": "NO",
    "description": "string",
    "green_status": "GREEN",
    "features": {}
    }
    ]
    }