Replication resources

Replication resources let you configure, monitor, and manage replication. The table below provides information about these resources.

.../services/replication

Data typeMethodUseAccessNotes

replication

Service

GETRetrieve Replication service settingsSystem-level user account with the monitor or administrator role
POSTModify Replication service settings or perform an action on the Replication serviceSystem-level user account with the administrator role

.../services/replication/certificates

Data typeMethodUseAccessNotes
CertificatesGETRetrieves a list of replication certificatesSystem-level user account with the monitor or administrator role
N/APUTUploads a new replication certificateSystem-level user account with the administrator role

.../services/replication/certificates/certificate-id

Data typeMethodUseAccessNotes
TextGETRetrieve information about a replication certificateSystem-level user account with the monitor or administrator role
N/ADELETEDelete a replication certificateSystem-level user account with the administrator role

.../services/replication/certificates/server

Data typeMethodUseAccessNotes
TextGETDownloads the replication server certificate and saves it on your computer as a server_certificate.txt fileSystem-level user account with the administrator role

.../services/replication/links

Data typeMethodUseAccessNotes
linkPUTCreate a replication linkSystem-level user account with the administrator role
ListGETRetrieve a list of the replication links in which the HCP system being queried participatesSystem-level user account with the monitor or administrator role

The listed replication links are identified by link name.

In XML, the element that identifies each link is name. The root element for the list of links is links.

In JSON, the name in the name/value pair that lists the links is name.

.../services/replication/links/link-name

Data typeMethodUseAccessNotes
linkGETRetrieve information about a replication linkSystem-level user account with the monitor or administrator role
N/AHEADCheck for the existence of a replication linkSystem-level user account with the monitor or administrator role
linkPOSTModify or perform an action on a replication linkSystem-level user account with the administrator role
N/ADELETEDelete a replication linkSystem-level user account with the administrator role

.../services/replication/links/link-name/content

Data typeMethodUseAccessNotes
contentGETRetrieve a list of the items included in a replication linkSystem-level user account with the monitor or administrator role

.../services/replication/links/link-name/content/defaultNamespaceDirectories

Data typeMethodUseAccessNotes
ListGETRetrieve a list of the default-namespace directories included in a replication linkSystem-level user account with the monitor or administrator role

This resource is available only if the default tenant exists.

The listed directories are identified by directory name.

In XML, the element that identifies each directory is name. The root element for the list of directories is defaultNamespace-Directories.

In JSON, the name in the name/value pair that lists the directories is name.

.../services/replication/links/link-name/content/defaultNamespaceDirectories/directory-name

Data typeMethodUseAccessNotes
N/APUTAdd a default-namespace directory to a replication linkSystem-level user account with the administrator role
DELETERemove a default-namespace directory from a replication linkSystem-level user account with the administrator role

.../services/replication/links/link-name/content/chainedLinks

Data typeMethodUseAccessNotes
ListGETRetrieve a list of the chained links included in an active/passive linkSystem-level user account with the monitor or administrator role

Not valid for active/active links.

The listed chained links are identified by link name.

In XML, the element that identifies each chained link is name. The root element of the list of chained links is chainedLinks.

In JSON, the name in the name/value pair that lists the chained links is name.

This resource is not valid for active/active links.

.../services/replication/links/link-name/content/chainedLinks/link-name

Data typeMethodUseAccessNotes
N/APUTAdd a chained link to an active/passive linkSystem-level user account with the administrator roleYou cannot add a chained link to an active/active link.
DELETERemove a chained link from an active/passive linkSystem-level user account with the administrator role

.../services/replication/links/link-name/content/tenants

Data typeMethodUseAccessNotes
ListGETRetrieve a list of the HCP tenants included in a replication linkSystem-level user account with the monitor or administrator role

The listed tenants are identified by tenant name.

In XML, the element that identifies each tenant is name. The root element for the list of tenants is tenants.

In JSON, the name in the name/value pair that lists the tenants is name.

.../services/replication/links/link-name/content/tenants/tenant-name

Data typeMethodUseAccessNotes
N/APUTAdd an HCP tenant to a replication linkSystem-level user account with the administrator role

tenant

(data type for replication link content tenant)

GETRetrieve replication status information for a tenant included in a replication linkSystem-level user account with the monitor or administrator role
N/APOSTPerform an action on a tenant included in a replication linkSystem-level user account with the administrator role
DELETERemove an HCP tenant from a replication linkSystem-level user account with the administrator role

.../services/replication/links/link-name/localCandidates

Data typeMethodUseAccessNotes
contentGETRetrieve a list of the items on the system being queried that are eligible to be included in a replication linkSystem-level user account with the monitor or administrator role

.../services/replication/links/link-name/localCandidates/defaultNamespaceDirectories

Data typeMethodUseAccessNotes
ListGETRetrieve a list of the default-namespace directories on the system being queried that are eligible to be included in a a replication linkSystem-level user account with the monitor or administrator role

This resource is available only if the default tenant exists.

The listed directories are identified by directory name.

In XML, the element that identifies each directory is name. The root element for the list of directories is defaultNamespace-Directories.

In JSON, the name in the name/value pair that lists the directories is name.

.../services/replication/links/link-name/localCandidates/chainedLinks

Data typeMethodUseAccessNotes
ListGETRetrieve a list of the inbound links on the system being queried that are eligible to be included in an active/passive linkSystem-level user account with the monitor or administrator role

Not valid for active/active links.

The listed chained links are identified by link name.

In XML, the element that identifies each chained link is name. The root element of the list of chained links is chainedLinks.

In JSON, the name in the name/value pair that lists the chained links is name.

This resource is not valid for active/active links.

.../services/replication/links/link-name/localCandidates/tenants

Data typeMethodUseAccessNotes
ListGETRetrieve a list of the HCP tenants on the system being queried that are eligible to be included in a replication linkSystem-level user account with the monitor or administrator role

The listed tenants are identified by tenant name.

In XML, the element that identifies each tenant is name. The root element of the list of tenants is tenants.

In JSON, the name in the name/value pair that lists the tenants is name.

.../services/replication/links/link-name/remoteCandidates

Data typeMethodUseAccessNotes
contentGETRetrieve a list of the items on the other system involved in a replication link that are eligible to be included in the linkSystem-level user account with the monitor or administrator role

.../services/replication/links/link-name/remoteCandidates/defaultNamespaceDirectories

Data typeMethodUseAccessNotes
ListGETRetrieve a list of the default-namespace directories on the other system involved in a replication link that are eligible to be included in the linkSystem-level user account with the monitor or administrator role

This resource is available only if the default tenant exists.

The listed directories are identified by directory name.

In XML, the element that identifies each directory is name. The root element of the list of directories is defaultNamespace-Directories.

In JSON, the name in the name/value pair that lists the directories is name.

.../services/replication/links/link-name/remoteCandidates/chainedLinks

Data typeMethodUseAccessNotes
ListGETRetrieve a list of the inbound links on the other system involved in an active/passive link that are eligible to be included in the linkSystem-level user account with the monitor or administrator role

Not valid for active/active links.

The listed chained links are identified by link name.

In XML, the element that identifies each chained link is name. The root element of the list of chained links is chainedLinks.

In JSON, the name in the name/value pair that lists the chained links is name.

This resource is not valid for active/active links.

.../services/replication/links/link-name/remoteCandidates/tenants

Data typeMethodUseAccessNotes
ListGETRetrieve a list of the HCP tenants on the other system involved in a replication link that are eligible to be included in the linkSystem-level user account with the monitor or administrator role

The listed tenants are identified by directory name.

In XML, the element that identifies each tenant is name. The root element of the list of tenants is tenants.

In JSON, the name in the name/value pair that lists the tenants is name.

.../services/replication/links/link-name/schedule

Data typeMethodUseAccessNotes
scheduleGETRetrieve the schedules for an active/active link or the schedule for an active/passive linkSystem-level user account with the monitor or administrator role
POSTModify the schedules for an active/active link or the schedule for an active/passive linkSystem-level user account with the administrator role