Replication
All operations require authentication.
List replication rulesProduction
Returns the rules that copy new objects to other buckets.
Path parameters
Bucket name
Project ID
Response
Array of replication rules
Example uses bucketName = string, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ storage/ object/ bucket/ {bucketName}/ replication \
-H "authorization: Bearer $OVH_TOKEN"{ "rules": [ { "deleteMarkerReplication": "DISABLED", "destination": { "name": "string", "region": "string", "storageClass": "DEEP_ARCHIVE" }, "filter": { "prefix": "string", "tags": { "key": "string" } }, "id": "string", "priority": 0, "status": "DISABLED" } ]}
Replace replication rulesProduction
Replaces all replication rules of the bucket. An empty list deletes all rules.
Path parameters
Bucket name
Project ID
Request body (required)
Array of replication rules. An empty array deletes all rules.
Response
Array of replication rules
Example uses bucketName = string, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ storage/ object/ bucket/ {bucketName}/ replication \
-H "authorization: Bearer $OVH_TOKEN"{ "rules": [ { "deleteMarkerReplication": "DISABLED", "destination": { "name": "string", "region": "string", "storageClass": "DEEP_ARCHIVE" }, "filter": { "prefix": "string", "tags": { "key": "string" } }, "id": "string", "priority": 0, "status": "DISABLED" } ]}
List batch replication jobsProduction
Returns the batch replication jobs of the bucket and their progress.
Path parameters
Bucket name
Project ID
Headers
Pagination cursor
Pagination size
Response
Number of successfully replicated objects
Job creation date
Number of objects that failed to replicate
Unique identifier of the job
Job status
ACTIVECOMPLETEDCREATEDFAILEDPREPARINGNumber of stuck objects
Total number of objects to replicate
Example uses bucketName = string, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ storage/ object/ bucket/ {bucketName}/ replication/ trigger \
-H "authorization: Bearer $OVH_TOKEN"[ { "completed": 0, "createdAt": "2024-01-01T12:00:00Z", "failed": 0, "id": "string", "status": "ACTIVE", "stuck": 0, "total": 0 }]
Start a batch replication jobProduction
Applies the current replication rules to the objects already in the bucket.
Path parameters
Bucket name
Project ID
Response
Number of successfully replicated objects
Job creation date
Number of objects that failed to replicate
Unique identifier of the job
Job status
ACTIVECOMPLETEDCREATEDFAILEDPREPARINGNumber of stuck objects
Total number of objects to replicate
Example uses bucketName = string, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ storage/ object/ bucket/ {bucketName}/ replication/ trigger \
-H "authorization: Bearer $OVH_TOKEN"{ "completed": 0, "createdAt": "2024-01-01T12:00:00Z", "failed": 0, "id": "string", "status": "ACTIVE", "stuck": 0, "total": 0}
Get a batch replication jobProduction
Returns the progress of a batch replication job: total, completed, failed and stuck objects.
Path parameters
Bucket name
Id
Project ID
Response
Number of successfully replicated objects
Job creation date
Number of objects that failed to replicate
Unique identifier of the job
Job status
ACTIVECOMPLETEDCREATEDFAILEDPREPARINGNumber of stuck objects
Total number of objects to replicate
Example uses bucketName = string, id = string, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ storage/ object/ bucket/ {bucketName}/ replication/ trigger/ {id} \
-H "authorization: Bearer $OVH_TOKEN"{ "completed": 0, "createdAt": "2024-01-01T12:00:00Z", "failed": 0, "id": "string", "status": "ACTIVE", "stuck": 0, "total": 0}
List possible replication destinationsProduction
Returns the other buckets of the project and whether each one can receive objects replicated from this bucket. A bucket that cannot gives a reason: versioning disabled, incompatible object lock, or a region that does not accept replicated objects.
Path parameters
Bucket name
Project ID
Headers
Pagination cursor
Pagination size
Response
Whether this bucket can be used as the destination of a replication rule on the source bucket
Bucket name
Why the bucket cannot be used as a destination. Set only when eligible is false.
OBJECT_LOCK_INCOMPATIBLEREGION_NOT_REPLICATION_TARGETVERSIONING_DISABLEDRegion the bucket is located in
Example uses bucketName = string, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ storage/ object/ bucket/ {bucketName}/ replication/ destination \
-H "authorization: Bearer $OVH_TOKEN"[ { "eligible": true, "name": "string", "reason": "OBJECT_LOCK_INCOMPATIBLE", "region": "string" }]