Skip to content
Console(the OVHcloud Console, opens in a new tab)

References

All operations require authentication.

3 operationsv2/vrackServices/reference
OpenAPI
Agent setup

List regionsProduction

GET
/v2/vrackServices/reference/region

Returns the regions where vRack Services is available.

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Region[]successful operation
name
read-only
string

Region name

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/v2/vrackServices/reference/region \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "name": "string"  }]

List compatible service typesProduction

GET
/v2/vrackServices/reference/compatibleManagedServiceType

Returns the types of managed services that can get a Service Endpoint, as IAM resource types.

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200string[]successful operation

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/v2/vrackServices/reference/compatibleManagedServiceType \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "string"]

List feature availabilityProduction

GET
/v2/vrackServices/reference/featureAvailability

Returns, per region, the availability of each feature: bgp, netboot and each compatible managed service type, overall and in each availability zone. A feature missing from a region is not offered there.

Query parameters

region
string

Restrict the list to this region

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200RegionFeatureAvailability[]successful operation
features
read-only
object

Availability of each feature, keyed by feature: bgp, netboot and each compatible managed service type listed by /reference/compatibleManagedServiceType. New keys can be added at any time: ignore the keys you do not know. A feature missing from the map is not offered in the region: treat it as UNAVAILABLE.

region
read-only
string

Region name

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/v2/vrackServices/reference/featureAvailability \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "features": {      "key": {        "availabilityZones": [          {            "name": "string",            "status": "AVAILABLE"          }        ],        "status": "AVAILABLE"      }    },    "region": "string"  }]