Skip to content

Storage

All operations require authentication.

3 operationsv2/publicCloud/project
Agent setup

List block storage volume typesProduction

GET
/v2/publicCloud/project/{projectId}/reference/storage/block/volumeType

Returns the volume types with their IOPS, throughput and maximum volume size. The list holds one entry per volume type and region: a volume type sold in several regions appears once per region, with the figures of that region and the region in location. The regions already activated on the project and those the project can activate where a volume type is sold are both listed. location.regionActivated on each entry 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. Entries are grouped by volume type, then sorted by region name. For IOPS and throughput, level is the baseline, maximum the upper limit a volume can burst to, and guaranteed tells whether the baseline is guaranteed. maximumSize is the maximum volume size in GB.

Path parameters

projectId
required
string

Project ID

Query parameters

region
string

Optional region filter, case-insensitive. Keeps the entries of this region only. A region that does not exist is rejected. One the project can neither use nor activate returns an empty list.

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200VolumeType[]successful operation
iops
read-only
VolumeTypePerformance

Input/output operations per second of a volume of this type in this region

location
read-only
Location

Region where the volume type is sold to the project, whether that region is already activated on the project (regionActivated), and the availability zones of that region (availabilityZones), empty for a single-AZ region

maximumSize
read-only
integer

Maximum size of a volume of this type in this region in GB

name
read-only
VolumeTypeEnum

Volume type identifier, to use as the volume type when creating a volume

ValuesCLASSICHIGH_SPEEDHIGH_SPEED_GEN2
throughput
read-only
VolumeTypePerformance

Throughput of a volume of this type in this region. Null when no throughput figure is published for this region.

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/reference/storage/block/volumeType \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "iops": { "guaranteed": true, "level": { "unit": "IOPS", "value": 0 }, "maximum": { "unit": "IOPS", "value": 0 } }, "location": { "availabilityZones": [ "string" ], "region": "string", "regionActivated": true }, "maximumSize": 0, "name": "CLASSIC", "throughput": { "guaranteed": true, "level": { "unit": "IOPS", "value": 0 }, "maximum": { "unit": "IOPS", "value": 0 } } }]

List file storage share typesProduction

GET
/v2/publicCloud/project/{projectId}/reference/storage/file/shareType

Returns the file storage share types with their minimum and maximum share size in GB, IOPS and throughput, read from the OVHcloud commercial catalog. The list holds one entry per share type and region: a share type sold in several regions appears once per region, with the figures of that region and the region in location. The regions already activated on the project and those the project can activate where a share type is sold are both listed. location.regionActivated on each entry 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. Entries are sorted by share type name, then by region name. For IOPS and throughput, level is the baseline per GB, maximum the upper limit, and guaranteed tells whether the baseline is guaranteed. Use name as the share type when creating a share.

Path parameters

projectId
required
string

Project ID

Query parameters

region
string

Optional region filter, case-insensitive. Keeps the entries of this region only. A region that does not exist is rejected. One the project can neither use nor activate returns an empty list.

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200ShareType[]successful operation
iops
read-only
VolumeTypePerformance

Input/output operations per second of a file storage of this type in this region

location
read-only
Location

Region where the file storage type is sold to the project, whether that region is already activated on the project (regionActivated), and the availability zones of that region (availabilityZones), empty for a single-AZ region

maximumSize
read-only
integer

Maximum size of a file storage of this type in this region in GB

minimumSize
read-only
integer

Minimum size of a file storage of this type in this region in GB

name
read-only
FileStorageTypeEnum

File storage type identifier, to use as the type when creating a file storage

ValuesSTANDARD_1AZ
protocols
read-only
FileStorageProtocolEnum[]

Protocols a file storage of this type supports

ValuesNFS
throughput
read-only
VolumeTypePerformance

Throughput of a file storage of this type in this region. Null when no throughput figure is published for this region.

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/reference/storage/file/shareType \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "iops": { "guaranteed": true, "level": { "unit": "IOPS", "value": 0 }, "maximum": { "unit": "IOPS", "value": 0 } }, "location": { "availabilityZones": [ "string" ], "region": "string", "regionActivated": true }, "maximumSize": 0, "minimumSize": 0, "name": "STANDARD_1AZ", "protocols": [ "NFS" ], "throughput": { "guaranteed": true, "level": { "unit": "IOPS", "value": 0 }, "maximum": { "unit": "IOPS", "value": 0 } } }]

Get object storage reference dataProduction

GET
/v2/publicCloud/project/{projectId}/reference/storage/object

Returns the storage classes with their minimum billed retention, the values accepted at bucket creation, and the allowed durations for restoring an archived object. Region capabilities, such as replication support, are returned by each region in /reference/region.

Path parameters

projectId
required
string

Project ID

Response

200ObjectStoragesuccessful operation
bucketOptions
read-only
BucketOptions

Allowed values for the bucket creation options

storageClasses
read-only
StorageClass[]

Object storage classes and their billing constraints

validation
read-only
Validation

Input validation constraints applied to object storage resources

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/reference/storage/object \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "bucketOptions": { "encryptionAlgorithms": [ "AES256" ], "objectLockModes": [ "COMPLIANCE" ], "userRoles": [ { "isDefault": true, "name": "ADMIN" } ], "versioningStatuses": [ "DISABLED" ] }, "storageClasses": [ { "minBilledRetentionDays": 0, "name": "DEEP_ARCHIVE" } ], "validation": { "objectRestore": { "defaultDays": 0, "maxDays": 0, "minDays": 0 } }}