List OVH regions available to a credential

Return the OVH Cloud regions the supplied credential’s project can deploy in. Only these regions are valid for cluster creation.

GET /api/v1/clusters/ovh/regions

List OVH regions available to a credential

Python

import requests

url = "https://platform.ankra.app/api/v1/clusters/ovh/regions"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

200

{
  "regions": [
    "<string>"
  ],
  "region_details": [
    {
      "name": "<string>",
      "type": "<string>",
      "availability_zones": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Query Parameters

credential_id · string<uuid> · required

details · string

Pass 'true' to include region_details (each region's type and availability zones). Costs one OVH call per region, so it is opt-in.

Response

200

application/json

Regions retrieved successfully

regions · string[] · required

region_details · OvhRegionDetail · object[]

Each region's type and availability zones. Returned only when details=true; omitted otherwise because it costs one OVH call per region.

Show child attributes