Provides management options for remote storage unit subscriptions.

Required Configuration:

• workers/replication:  specifies the number of replication background tasks that will be available.
• zoneId: Defines the zone prefix that the staging repository will assign to all record keys.

Register

Registers a storage unit to pull records from a remote storage unit.

Request

The register storage unit PUT/POST request requires the local storage unit name in the URL and a JSON body with the remote storage unit information.

PUT replication/register/<storage-unit-name>
{
	"scope":"remoteScopeName",
	"storageUnit":"RemoteStorageUnitName",
	"port":"3000",
	"server":"localhost",
	"zone":"EAST"
}

Optional body parameters for SSL connections:

• cert: server path where the client certificate for the remote staging repository is stored.
• certKey: server path where the client's certificate key is stored.
• ca: server path where the ca certificate is stored.

Response

If the remote storage unit was successfully registered, a 200 response code with an OK message is returned.

{"message": "OK"}

Once registered, it will automatically start pulling records from the remote storage unit.

Unregister

Unregisters a remote storage unit subscription.

Request

The unregister storage unit DELETE/POST request requires the local storage unit name in the URL and a JSON body with the remote storage unit information to delete. 

PUT replication/unregister/<storage-unit-name>
{
	"scope":"remoteScopeName",
	"storageUnit":"RemoteStorageUnitName",
	"port":"3000",
	"server":"localhost",
	"zone":"EAST"
}

Response

If the remote storage unit was successfully unregistered, a 200 response code with an OK message is returned.

{"message": "OK"}

Pause

Pauses an active registered remote storage unit so it stops receiving updates from the remote storage unit.

Request

The pause remote storage unit PUT/POST request requires the local storage unit name in the URL and a JSON body with the remote storage unit information to pause. 

PUT replication/pause/<storage-unit-name>
{
	"scope":"remoteScopeName",
	"storageUnit":"RemoteStorageUnitName",
	"port":"3000",
	"server":"localhost",
	"zone":"EAST"
}

Response

If the remote storage unit was successfully paused, a 200 response code with an OK message is returned.

{"message": "OK"}

Resume

Resumes a paused remote storage unit so it starts again receiving updates from the remote storage unit.

Request

The resume remote storage unit PUT/POST request requires the local storage unit name in the URL and a JSON body with the remote storage unit information to resume. 

PUT replication/pause/<storage-unit-name>
{
	"scope":"remoteScopeName",
	"storageUnit":"RemoteStorageUnitName",
	"port":"3000",
	"server":"localhost",
	"zone":"EAST"
}

Response

If the remote storage unit was successfully resumed, a 200 response code with an OK message is returned.

{"message": "OK"}