Documentation | Regions › List Regions

Regions

regions

Methods

List Regions -> OffsetPage<{ id, access_level, ai_service_endpoint_id, 23 more... }>

get/v1/regions

List regions

Parameters

limit: number

Optional

(exclusiveMinimum: 0, maximum: 1000)

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

offset: number

Optional

(minimum: 0)

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

product: string

Optional

Currently supported products: 'containers' and 'inference'. If defined then return only regions with defined product.

show_volume_types: boolean

Optional

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

Response fields

count: number

(minimum: 0)

Number of objects

results: Array<{ id, access_level, ai_service_endpoint_id, 23 more... }>

Objects

Request example

curl https://api.gcore.com/cloud/v1/regions \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "count": 1,
  "results": [
    {
      "id": 1,
      "access_level": "core",
      "ai_service_endpoint_id": 6,
      "available_volume_types": [
        "standard",
        "ssd_hiiops",
        "cold"
      ],
      "coordinates": {
        "latitude": 41.40338,
        "longitude": 2.17403
      },
      "country": "LU",
      "created_on": "2019-12-27T18:11:19.117Z",
      "ddos_endpoint_id": 3,
      "display_name": "Luxembourg 1",
      "endpoint_type": "admin",
      "external_network_id": "c843c3e6-ef4d-4b92-8db2-e16ac05c5650",
      "has_ai": true,
      "has_ai_gpu": true,
      "has_baremetal": false,
      "has_basic_vm": false,
      "has_k8s": true,
      "has_kvm": true,
      "has_sfs": false,
      "keystone_id": 1,
      "keystone_name": "ED-8",
      "metrics_database_id": 1,
      "state": "ACTIVE",
      "task_id": "task_id",
      "vlan_physical_network": "br-ex",
      "zone": "AMERICAS",
      "has_dbaas": false
    }
  ]
}

Get Region -> { id, access_level, ai_service_endpoint_id, 23 more... }

get/v1/regions/{region_id}

Get region

Regions

Reseller Regions

regions.reseller_regions

Methods

Delete Reseller S Region Access Records ->

delete/v1/reseller_region/{reseller_id}

Delete reseller's region access records

Get A List Of Region Access Records For A Client Or A Reseller -> { count, results }

get/v1/reseller_region

Get a list of region access records for a client or a reseller

Create Or Update The Limit Of Regions For Clients Of The Reseller -> { id, client_name, reseller_name, 4 more... }

put/v1/reseller_region

Region access management. Resellers can open or close access to specific 'core' or 'edge' regions for all their clients either individually or collectively. Cloud admins can do it for any clients. By default, only 'core' regions are available to clients.