List regions

GET /cloud/v1/regions

List regions

cURL

curl --request GET \
  --url https://api.gcore.com/cloud/v1/regions \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.gcore.com/cloud/v1/regions"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/cloud/v1/regions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/cloud/v1/regions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/cloud/v1/regions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/cloud/v1/regions")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/regions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "count": 1,
  "results": [
    {
      "available_volume_types": [
        "standard",
        "ssd_hiiops",
        "cold"
      ],
      "coordinates": {
        "latitude": 41.40338,
        "longitude": 2.17403
      },
      "country": "LU",
      "created_at": "2019-12-31T23:59:59",
      "created_on": "2019-12-31T23:59:59",
      "display_name": "Luxembourg",
      "external_network_id": "c843c3e6-ef4d-4b92-8db2-e16ac05c5650",
      "file_share_types": [
        "standard",
        "vast"
      ],
      "has_ai": true,
      "has_ai_gpu": true,
      "has_baremetal": false,
      "has_basic_vm": false,
      "has_dbaas": false,
      "has_ddos": true,
      "has_k8s": true,
      "has_kvm": true,
      "has_sfs": false,
      "id": 1,
      "keystone_id": 1,
      "keystone_name": "ED-9",
      "metrics_database_id": 1,
      "slug": "luxembourg-1",
      "task_id": null,
      "vlan_physical_network": "br-ex",
      "zone": "EMEA",
      "ddos_endpoint_id": 3
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

display_name · string

Filter regions by display name. Case-insensitive exact match.

Example:

"Luxembourg"

limit · integer · default: 100

Limit the number of returned regions. Falls back to default of 100 if not specified. Limited by max limit value of 1000

Required range: x <= 1000

Example:

100

offset · integer · default: 0

Offset value is used to exclude the first set of records from the result

Required range: x >= 0

Example:

0

order_by · enum<string> · default: created_at.desc

Order by field and direction.

Available options: created_at.asc, created_at.desc, display_name.asc, display_name.desc

Example:

"created_at.desc"

product · enum<string>

If defined then return only regions that support given product.

Available options: containers, inference

Example:

"inference"

show_volume_types · boolean · default: false

If true, null available_volume_type is replaced with a list of available volume types.

Example:

false

Response

200 - application/json

OK

count · integer · required

Number of objects

Required range: x >= 0

Example:

1

results · Region object · object[] · required

Objects

Show child attributes