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 instance flavorsProduction
Returns the instance flavors available to the project, in the regions activated on the project and in those the project can activate. location.regionActivated on each flavor tells which regions must be activated on the project before use. location.availabilityZones lists the availability zones of the region, for example eu-west-par-a, eu-west-par-b and eu-west-par-c, and is empty for a single-AZ region. A region filter on a region that does not exist is rejected. On a region the project can neither use nor activate, it returns an empty list. A flavor is a read-only sizing template (vCPUs, RAM, disk) used to create or resize an instance. A new or disabled flavor, or a private flavor newly granted to the project, can take up to one minute to show in this list.
Path parameters
Project ID
Query parameters
Optional flavor name filter, for example b2-7
Optional region filter
Headers
Pagination cursor
Pagination size
Response
Network bandwidth an instance of the flavor gets in Mbit/s
Free-form description of the flavor as reported by the backend. Null when no description is advertised for this flavor.
Size of the flavor's root disk in GB. This is the primary system disk provisioned for instances created from this flavor.
Size of the flavor's ephemeral disk in GB. Ephemeral storage is transient. Its contents do not survive a rebuild or deletion of the instance. Zero when the flavor provides no ephemeral disk.
Number of physical GPUs provided by the flavor. Zero for flavors without GPU.
Identifier. The OpenStack/Nova flavor ID. Stable within a region and used to reference the flavor when creating an instance.
Public availability. Whether the flavor is publicly available to the project. Private flavors are only visible to the projects they have been explicitly shared with.
Location. Region where this flavor is offered. The flavor catalog is per-region: a flavor returned for one region is not guaranteed to exist, or to carry the same characteristics, in another. regionActivated tells whether the region is already activated on the project. When false, the region must be activated on the project before use. availabilityZones lists the availability zones of the region, empty for a single-AZ region.
The backend flavor name, for example b2-7, c2-15. This is the commercial/technical name used to identify the sizing in the catalog.
RAM in MB. Amount of memory provided by the flavor, expressed in MB.
Size of the flavor's swap space in MB. Zero when the flavor provides no swap.
vCPUs. Number of virtual CPUs provided by the flavor.
Example uses projectId = string
$ curl https:/[ { "bandwidth": { "private": 0, "publicInbound": 0, "publicOutbound": 0 }, "description": "string", "disk": 0, "ephemeral": 0, "gpus": 0, "id": "00000000-0000-0000-0000-000000000000", "isPublic": true, "location": { "availabilityZones": [ "string" ], "region": "string", "regionActivated": true }, "name": "string", "ram": 0, "swap": 0, "vcpus": 0 }]
Get an instance flavorProduction
Returns one instance flavor with its vCPUs, RAM and disk. location.regionActivated tells whether the flavor's region is already activated on the project. When false, the region must be activated on the project before use. location.availabilityZones lists the availability zones of the region, for example eu-west-par-a, eu-west-par-b and eu-west-par-c, and is empty for a single-AZ region. Use its id in targetSpec.flavor to create or resize an instance.
Path parameters
Id
Project ID
Response
Network bandwidth an instance of the flavor gets in Mbit/s
Free-form description of the flavor as reported by the backend. Null when no description is advertised for this flavor.
Size of the flavor's root disk in GB. This is the primary system disk provisioned for instances created from this flavor.
Size of the flavor's ephemeral disk in GB. Ephemeral storage is transient. Its contents do not survive a rebuild or deletion of the instance. Zero when the flavor provides no ephemeral disk.
Number of physical GPUs provided by the flavor. Zero for flavors without GPU.
Identifier. The OpenStack/Nova flavor ID. Stable within a region and used to reference the flavor when creating an instance.
Public availability. Whether the flavor is publicly available to the project. Private flavors are only visible to the projects they have been explicitly shared with.
Location. Region where this flavor is offered. The flavor catalog is per-region: a flavor returned for one region is not guaranteed to exist, or to carry the same characteristics, in another. regionActivated tells whether the region is already activated on the project. When false, the region must be activated on the project before use. availabilityZones lists the availability zones of the region, empty for a single-AZ region.
The backend flavor name, for example b2-7, c2-15. This is the commercial/technical name used to identify the sizing in the catalog.
RAM in MB. Amount of memory provided by the flavor, expressed in MB.
Size of the flavor's swap space in MB. Zero when the flavor provides no swap.
vCPUs. Number of virtual CPUs provided by the flavor.
Example uses id = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/{ "bandwidth": { "private": 0, "publicInbound": 0, "publicOutbound": 0 }, "description": "string", "disk": 0, "ephemeral": 0, "gpus": 0, "id": "00000000-0000-0000-0000-000000000000", "isPublic": true, "location": { "availabilityZones": [ "string" ], "region": "string", "regionActivated": true }, "name": "string", "ram": 0, "swap": 0, "vcpus": 0}
List instance imagesProduction
Returns the operating system images available to the project. Images are provided by the platform and are read-only.
Path parameters
Project ID
Query parameters
Optional region filter
Headers
Pagination cursor
Pagination size
Response
Creation date. Timestamp at which the image was created on the backend, in RFC 3339 format.
Default login user of the image, as set by its publisher, for example almalinux or ubuntu. Null when the image declares none.
Identifier. The OpenStack/Glance image ID. Stable within a region and used to reference the image when creating an instance.
Location. Region (and, where applicable, availability zone) where this image is offered. The image catalog is per-region: an image returned for one region is not guaranteed to exist in another.
Minimum root disk size in GB that an instance must provide to boot from this image. A flavor whose disk is smaller than this value cannot be used with the image.
Minimum amount of memory in MB that an instance must provide to boot from this image. A flavor whose RAM is below this value cannot be used with the image.
Display name of the image as reported by the backend, for example the distribution and version, such as Debian 12
Operating system type. Operating system family of the image (see ImageOSTypeEnum). Windows images can only boot on Windows flavors.
BAREMETAL_LINUXLINUXWINDOWSSize of the image on the backend, expressed in bytes
Availability status of the image as reported by the backend (see ImageStatusEnum). Only images in an active status can be used to create an instance.
ACTIVEDEACTIVATEDDELETEDIMPORTINGKILLEDPENDING_DELETEQUEUEDSAVINGLast update date. Timestamp of the last modification of the image on the backend, in RFC 3339 format.
Visibility scope of the image (see ImageVisibilityEnum), for example whether it is a public OVHcloud-provided image or private to the project
COMMUNITYPRIVATEPUBLICSHAREDExample uses projectId = string
$ curl https:/[ { "createdAt": "2024-01-01T12:00:00Z", "defaultUser": "string", "id": "00000000-0000-0000-0000-000000000000", "location": { "availabilityZone": "string", "region": "string" }, "minDisk": 0, "minRam": 0, "name": "string", "osType": "BAREMETAL_LINUX", "size": 0, "status": "ACTIVE", "updatedAt": "2024-01-01T12:00:00Z", "visibility": "COMMUNITY" }]
Get an instance imageProduction
Returns one operating system image. Use its id in targetSpec.image to create or rebuild an instance.
Path parameters
Id
Project ID
Response
Creation date. Timestamp at which the image was created on the backend, in RFC 3339 format.
Default login user of the image, as set by its publisher, for example almalinux or ubuntu. Null when the image declares none.
Identifier. The OpenStack/Glance image ID. Stable within a region and used to reference the image when creating an instance.
Location. Region (and, where applicable, availability zone) where this image is offered. The image catalog is per-region: an image returned for one region is not guaranteed to exist in another.
Minimum root disk size in GB that an instance must provide to boot from this image. A flavor whose disk is smaller than this value cannot be used with the image.
Minimum amount of memory in MB that an instance must provide to boot from this image. A flavor whose RAM is below this value cannot be used with the image.
Display name of the image as reported by the backend, for example the distribution and version, such as Debian 12
Operating system type. Operating system family of the image (see ImageOSTypeEnum). Windows images can only boot on Windows flavors.
BAREMETAL_LINUXLINUXWINDOWSSize of the image on the backend, expressed in bytes
Availability status of the image as reported by the backend (see ImageStatusEnum). Only images in an active status can be used to create an instance.
ACTIVEDEACTIVATEDDELETEDIMPORTINGKILLEDPENDING_DELETEQUEUEDSAVINGLast update date. Timestamp of the last modification of the image on the backend, in RFC 3339 format.
Visibility scope of the image (see ImageVisibilityEnum), for example whether it is a public OVHcloud-provided image or private to the project
COMMUNITYPRIVATEPUBLICSHAREDExample uses id = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/{ "createdAt": "2024-01-01T12:00:00Z", "defaultUser": "string", "id": "00000000-0000-0000-0000-000000000000", "location": { "availabilityZone": "string", "region": "string" }, "minDisk": 0, "minRam": 0, "name": "string", "osType": "BAREMETAL_LINUX", "size": 0, "status": "ACTIVE", "updatedAt": "2024-01-01T12:00:00Z", "visibility": "COMMUNITY"}