CubePathDOCS

Object Storage

Create replication

post/object-storage/replications

Replicate a bucket to another CubePath bucket (in this organization, or in another one that gave you a replication grant) or to an external S3 compatible bucket over HTTPS. Versioning must be enabled. New objects are copied as they are written and, by default, the existing ones too. Both CubePath buckets are in the same storage cluster, so it is not a disaster recovery copy; replication to an external destination is billed as egress.

Authorization

Authorization
Authorization*string

Bearer YOUR_API_TOKEN with an API token. The X-API-Key: YOUR_API_TOKEN header works too.

Request body

Replicate a bucket to one destination.

application/jsonRequired
source_bucket_uuid*string
Rangelength ≤ 36
destination*ObjectStorageReplicationDestinationIn

Where to replicate: a CubePath bucket (bucket_uuid, plus grant_token when it belongs to another organization) or an external S3 compatible bucket (endpoint, region, bucket and keys).

Properties (10)
type*string
Value in"cubepath""external"
bucket_uuid?string | null

cubepath: the destination bucket

Rangelength ≤ 36
grant_token?string | null

cubepath: the grant of the destination owner (another organization)

Rangelength ≤ 64
provider?string | null

external: informative

Value in"aws""wasabi""other"
endpoint?string | null

external: public HTTPS host of the provider, optionally with :443

Range3 ≤ length ≤ 253
region?string | null
Range1 ≤ length ≤ 64
bucket?string | null
Range3 ≤ length ≤ 63
path_style?string | null

external: default auto

Value in"auto""on""off"
access_key_id?string | null
Range1 ≤ length ≤ 128
secret_access_key?string | null

Never returned

Range1 ≤ length ≤ 256
prefix?string | null
Range1 ≤ length ≤ 1024
tags?array<ObjectStorageReplicationTag> | null
Rangeitems ≥ 1Rangeitems ≤ 10
Properties (2)
key*string
Range1 ≤ length ≤ 128
value*string
Rangelength ≤ 256
delete_marker_replication?boolean

Replicate delete markers

Defaultfalse
delete_replication?boolean

Replicate deletes of a specific version

Defaultfalse
existing_objects?boolean

Copy the objects the bucket already holds

Defaulttrue

Responses

Successful Response

application/json

detail*string
uuid*string
status*string