Service references
All operations require authentication.
Get product availabilityProduction
Product availability
Returns the products available to this Public Cloud project, grouped by product type.
This is read-only reference data: the response is computed from the OVHcloud commercial catalog combined with the project's entitlements and its quota usage. It does not reflect existing resources and triggers no OpenStack call.
The response is an array with one entry per product type, in this order: INSTANCE, VOLUME, LOADBALANCER, GATEWAY, FLOATING_IP, PUBLIC_IP, VOLUME_SNAPSHOT, VOLUME_BACKUP, INSTANCE_SNAPSHOT, SHARE, SHARE_SNAPSHOT, OBJECT_STORAGE, SWIFT. Each type group carries its models. Each model carries the locations where it is sold to the project, in the regions activated on the project and in those the project can activate. Each location reports its availability zones, regionActivated, a quotaStatus with the quota resources that block it (quotaLimitedBy) and, for the INSTANCE type only, a stockStatus per availability zone.
links point to related operations: a SPECS link on a model leads to the reference route describing it, and a location whose quotaStatus is INSUFFICIENT carries a QUOTA link.
Every filter is optional: type keeps the group of that product type only, region the locations of that region (letter case ignored), name the models with exactly that name and nameContains the models whose name contains that value (letter case ignored).
Path parameters
Project ID
Query parameters
Optional exact model name filter, for example b3-8
Optional model name filter keeping the names that contain this value, letter case ignored
Optional region filter, letter case ignored
Optional product type filter
FLOATING_IPGATEWAYINSTANCEINSTANCE_SNAPSHOTLOADBALANCEROBJECT_STORAGEPUBLIC_IPSHARESHARE_SNAPSHOTSWIFTVOLUMEVOLUME_BACKUPVOLUME_SNAPSHOTHeaders
Pagination cursor
Pagination size
Response
The offerings of this product type available to the project, each with its per-location availability. Null or empty when no model is available.
Product type. The product family this group describes. Groups come in this order: INSTANCE, VOLUME, LOADBALANCER, GATEWAY, FLOATING_IP, PUBLIC_IP, VOLUME_SNAPSHOT, VOLUME_BACKUP, INSTANCE_SNAPSHOT, SHARE, SHARE_SNAPSHOT, OBJECT_STORAGE, SWIFT.
FLOATING_IPGATEWAYINSTANCEINSTANCE_SNAPSHOTLOADBALANCEROBJECT_STORAGEPUBLIC_IPSHARESHARE_SNAPSHOTSWIFTVOLUMEVOLUME_BACKUPVOLUME_SNAPSHOTExample uses projectId = string
$ curl https:/[ { "models": [ { "links": [ { "href": "string", "kind": "QUOTA" } ], "locations": [ { "availabilityZones": [ null ], "links": [ null ], "name": "string", "quotaLimitedBy": [ null ], "quotaStatus": "INSUFFICIENT", "regionActivated": true, "stockStatus": { "key": null } } ], "name": "string" } ], "type": "FLOATING_IP" }]
List regionsBeta
Returns the regions with their type, status, location and available services.
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Whether the region is activated on the project. When false, the region exists but has not yet been activated for the project.
Availability zones in this region
Continent code
Country code
Datacenter display name
Region identifier, for example GRA1
Object storage capabilities of the region. Null when the region offers no object storage.
Available services. Includes objectStorage when S3™ object storage is available in the region, that is the region has a non-null objectStorage block whose bareContainerOnly is false.
Region status
DISABLEDENABLEDMAINTENANCERegion type. Null when the catalog reports an unrecognized type.
LOCAL-ZONEREGION-1-AZREGION-3-AZExample uses projectId = string
$ curl https:/[ { "activated": true, "availabilityZones": [ "string" ], "continent": "string", "country": "string", "datacenterName": "string", "name": "string", "objectStorage": { "bareContainerOnly": true, "isReplicationTarget": true, "lifecycleTargetClasses": [ "DEEP_ARCHIVE" ], "replicationSupported": true, "storageClasses": [ "DEEP_ARCHIVE" ] }, "services": [ "string" ], "status": "DISABLED", "type": "LOCAL-ZONE" }]
Get a regionBeta
Returns one region: its availability zones, location, status and available services, including its object storage capabilities.
Path parameters
Name
Project ID
Response
Whether the region is activated on the project. When false, the region exists but has not yet been activated for the project.
Availability zones in this region
Continent code
Country code
Datacenter display name
Region identifier, for example GRA1
Object storage capabilities of the region. Null when the region offers no object storage.
Available services. Includes objectStorage when S3™ object storage is available in the region, that is the region has a non-null objectStorage block whose bareContainerOnly is false.
Region status
DISABLEDENABLEDMAINTENANCERegion type. Null when the catalog reports an unrecognized type.
LOCAL-ZONEREGION-1-AZREGION-3-AZExample uses name = string, projectId = string
$ curl https:/{ "activated": true, "availabilityZones": [ "string" ], "continent": "string", "country": "string", "datacenterName": "string", "name": "string", "objectStorage": { "bareContainerOnly": true, "isReplicationTarget": true, "lifecycleTargetClasses": [ "DEEP_ARCHIVE" ], "replicationSupported": true, "storageClasses": [ "DEEP_ARCHIVE" ] }, "services": [ "string" ], "status": "DISABLED", "type": "LOCAL-ZONE"}