Share Replication
All operations require authentication.
List share replicationsBeta
Returns the share replications of the service, whether this service is the source or the destination.
Path parameters
Service name
Response
Share replication creation date
Share replication description
Share replication destination information
Share replication ID
Percentage of the source share’s data that has been successfully replicated to the destination share
Share replica state
activeerrorin_syncout_of_syncShare replication source information
Share replication status
acceptedcompletedcutovercutting_overdeleteddeletingerrorpendingExample uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/1[2 {3 "createdAt": "2024-01-01T12:00:00Z",4 "description": "string",5 "destination": {6 "serviceID": "00000000-0000-0000-0000-000000000000",7 "shareID": "00000000-0000-0000-0000-000000000000"8 },9 "id": "00000000-0000-0000-0000-000000000000",10 "progress": 0,11 "replicaState": "active",12 "source": {13 "serviceID": "00000000-0000-0000-0000-000000000000",14 "shareID": "00000000-0000-0000-0000-000000000000"15 },16 "status": "accepted"17 }18]
Get a share replicationBeta
Returns the source, destination, status and progress of the replication, in percent.
Path parameters
Service name
Share replication ID
Response
Share replication creation date
Share replication description
Share replication destination information
Share replication ID
Percentage of the source share’s data that has been successfully replicated to the destination share
Share replica state
activeerrorin_syncout_of_syncShare replication source information
Share replication status
acceptedcompletedcutovercutting_overdeleteddeletingerrorpendingExample uses serviceName = 00000000-0000-0000-0000-000000000000, shareReplicationId = 00000000-0000-0000-0000-000000000000
$ curl https:/1{2 "createdAt": "2024-01-01T12:00:00Z",3 "description": "string",4 "destination": {5 "serviceID": "00000000-0000-0000-0000-000000000000",6 "shareID": "00000000-0000-0000-0000-000000000000"7 },8 "id": "00000000-0000-0000-0000-000000000000",9 "progress": 0,10 "replicaState": "active",11 "source": {12 "serviceID": "00000000-0000-0000-0000-000000000000",13 "shareID": "00000000-0000-0000-0000-000000000000"14 },15 "status": "accepted"16}
List compatible replication destinationsBeta
Returns, for each service on which you are allowed to accept share replications, whether it can be a destination for share replications from this service, and the reason when it cannot. A destination is compatible when it is in the same region as the source service, and when the source service uses a public network while the destination uses a vRack network. Set compatibleOnly to true to return only compatible destinations.
Path parameters
Service name
Query parameters
If set to true, only services compatible as share replication destinations for the given source are returned
Response
Whether service can be used as destination
Indicates why service can't be used as destination if applicable
Summarized properties of the checked service
Example uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/1[2 {3 "compatible": true,4 "reason": "string",5 "service": {6 "id": "00000000-0000-0000-0000-000000000000",7 "name": "string"8 }9 }10]
Create a share replicationBeta
Creates a share replication from a share of this service to the service given in destinationServiceId. It is returned with status pending, and the replication only starts after it is accepted on the destination service. To find a compatible destination, use List compatible replication destinations.
Path parameters
Service name
Request body (required)
Share replication description
Replication service ID (destination)
Replication share ID (source)
Response
Share replication creation date
Share replication description
Share replication destination information
Share replication ID
Percentage of the source share’s data that has been successfully replicated to the destination share
Share replica state
activeerrorin_syncout_of_syncShare replication source information
Share replication status
acceptedcompletedcutovercutting_overdeleteddeletingerrorpendingExample uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/1{2 "createdAt": "2024-01-01T12:00:00Z",3 "description": "string",4 "destination": {5 "serviceID": "00000000-0000-0000-0000-000000000000",6 "shareID": "00000000-0000-0000-0000-000000000000"7 },8 "id": "00000000-0000-0000-0000-000000000000",9 "progress": 0,10 "replicaState": "active",11 "source": {12 "serviceID": "00000000-0000-0000-0000-000000000000",13 "shareID": "00000000-0000-0000-0000-000000000000"14 },15 "status": "accepted"16}
Accept a share replicationBeta
Accepts the share replication and creates the destination share on this service, with the name, size and protocol given in the body. The replication must be in status pending. Acceptance is asynchronous: the replication is returned with status accepted, follow its progress until the replica state is in_sync.
Path parameters
Service name
Share replication ID
Request body (required)
Replication share
Response
Share replication creation date
Share replication description
Share replication destination information
Share replication ID
Percentage of the source share’s data that has been successfully replicated to the destination share
Share replica state
activeerrorin_syncout_of_syncShare replication source information
Share replication status
acceptedcompletedcutovercutting_overdeleteddeletingerrorpendingExample uses serviceName = 00000000-0000-0000-0000-000000000000, shareReplicationId = 00000000-0000-0000-0000-000000000000
$ curl https:/1{2 "createdAt": "2024-01-01T12:00:00Z",3 "description": "string",4 "destination": {5 "serviceID": "00000000-0000-0000-0000-000000000000",6 "shareID": "00000000-0000-0000-0000-000000000000"7 },8 "id": "00000000-0000-0000-0000-000000000000",9 "progress": 0,10 "replicaState": "active",11 "source": {12 "serviceID": "00000000-0000-0000-0000-000000000000",13 "shareID": "00000000-0000-0000-0000-000000000000"14 },15 "status": "accepted"16}
Cut over a share replicationBeta
Cuts over the share replication: the destination share becomes the primary, the replication stops, and the source and destination data diverge after it, so the operation cannot be undone. The call must be made on the destination service, and the replication must be in status accepted. The cutover is asynchronous: follow the status of the share replication until it is completed.
Path parameters
Service name
Share replication ID
Response
Share replication creation date
Share replication description
Share replication destination information
Share replication ID
Percentage of the source share’s data that has been successfully replicated to the destination share
Share replica state
activeerrorin_syncout_of_syncShare replication source information
Share replication status
acceptedcompletedcutovercutting_overdeleteddeletingerrorpendingExample uses serviceName = 00000000-0000-0000-0000-000000000000, shareReplicationId = 00000000-0000-0000-0000-000000000000
$ curl https:/1{2 "createdAt": "2024-01-01T12:00:00Z",3 "description": "string",4 "destination": {5 "serviceID": "00000000-0000-0000-0000-000000000000",6 "shareID": "00000000-0000-0000-0000-000000000000"7 },8 "id": "00000000-0000-0000-0000-000000000000",9 "progress": 0,10 "replicaState": "active",11 "source": {12 "serviceID": "00000000-0000-0000-0000-000000000000",13 "shareID": "00000000-0000-0000-0000-000000000000"14 },15 "status": "accepted"16}
Delete a share replicationBeta
Deletes the share replication. Deletion is asynchronous and blocked while the replication is in status cutting_over, deleting or error. If the replication was accepted, the destination share is deleted with it.
Path parameters
Service name
Share replication ID
Response
Example uses serviceName = 00000000-0000-0000-0000-000000000000, shareReplicationId = 00000000-0000-0000-0000-000000000000
$ curl https:/