Replication resources
Replication resources let you configure, monitor, and manage replication. The table below provides information about these resources.
.../services/replication
Data type | Method | Use | Access | Notes |
replication Service | GET | Retrieve Replication service settings | System-level user account with the monitor or administrator role | |
POST | Modify Replication service settings or perform an action on the Replication service | System-level user account with the administrator role |
.../services/replication/certificates
Data type | Method | Use | Access | Notes |
Certificates | GET | Retrieves a list of replication certificates | System-level user account with the monitor or administrator role | |
N/A | PUT | Uploads a new replication certificate | System-level user account with the administrator role |
.../services/replication/certificates/certificate-id
Data type | Method | Use | Access | Notes |
Text | GET | Retrieve information about a replication certificate | System-level user account with the monitor or administrator role | |
N/A | DELETE | Delete a replication certificate | System-level user account with the administrator role |
.../services/replication/certificates/server
Data type | Method | Use | Access | Notes |
Text | GET | Downloads the replication server certificate and saves it on your computer as a server_certificate.txt file | System-level user account with the administrator role |
.../services/replication/links
Data type | Method | Use | Access | Notes |
link | PUT | Create a replication link | System-level user account with the administrator role | |
List | GET | Retrieve a list of the replication links in which the HCP system being queried participates | System-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 type | Method | Use | Access | Notes |
link | GET | Retrieve information about a replication link | System-level user account with the monitor or administrator role | |
N/A | HEAD | Check for the existence of a replication link | System-level user account with the monitor or administrator role | |
link | POST | Modify or perform an action on a replication link | System-level user account with the administrator role | |
N/A | DELETE | Delete a replication link | System-level user account with the administrator role |
.../services/replication/links/link-name/content
Data type | Method | Use | Access | Notes |
content | GET | Retrieve a list of the items included in a replication link | System-level user account with the monitor or administrator role |
.../services/replication/links/link-name/content/defaultNamespaceDirectories
Data type | Method | Use | Access | Notes |
List | GET | Retrieve a list of the default-namespace directories included in a replication link | System-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 In JSON, the name in the name/value pair that lists the directories is |
.../services/replication/links/link-name/content/defaultNamespaceDirectories/directory-name
Data type | Method | Use | Access | Notes |
N/A | PUT | Add a default-namespace directory to a replication link | System-level user account with the administrator role | |
DELETE | Remove a default-namespace directory from a replication link | System-level user account with the administrator role |
.../services/replication/links/link-name/content/chainedLinks
Data type | Method | Use | Access | Notes |
List | GET | Retrieve a list of the chained links included in an active/passive link | System-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 In JSON, the name in the name/value pair that lists the chained links is This resource is not valid for active/active links. |
.../services/replication/links/link-name/content/chainedLinks/link-name
Data type | Method | Use | Access | Notes |
N/A | PUT | Add a chained link to an active/passive link | System-level user account with the administrator role | You cannot add a chained link to an active/active link. |
DELETE | Remove a chained link from an active/passive link | System-level user account with the administrator role |
.../services/replication/links/link-name/content/tenants
Data type | Method | Use | Access | Notes |
List | GET | Retrieve a list of the HCP tenants included in a replication link | System-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 In JSON, the name in the name/value pair that lists the tenants is |
.../services/replication/links/link-name/content/tenants/tenant-name
Data type | Method | Use | Access | Notes |
N/A | PUT | Add an HCP tenant to a replication link | System-level user account with the administrator role | |
tenant (data type for replication link content tenant) | GET | Retrieve replication status information for a tenant included in a replication link | System-level user account with the monitor or administrator role | |
N/A | POST | Perform an action on a tenant included in a replication link | System-level user account with the administrator role | |
DELETE | Remove an HCP tenant from a replication link | System-level user account with the administrator role |
.../services/replication/links/link-name/localCandidates
Data type | Method | Use | Access | Notes |
content | GET | Retrieve a list of the items on the system being queried that are eligible to be included in a replication link | System-level user account with the monitor or administrator role |
.../services/replication/links/link-name/localCandidates/defaultNamespaceDirectories
Data type | Method | Use | Access | Notes |
List | GET | Retrieve a list of the default-namespace directories on the system being queried that are eligible to be included in a a replication link | System-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 In JSON, the name in the name/value pair that lists the directories is |
.../services/replication/links/link-name/localCandidates/chainedLinks
Data type | Method | Use | Access | Notes |
List | GET | Retrieve a list of the inbound links on the system being queried that are eligible to be included in an active/passive link | System-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 In JSON, the name in the name/value pair that lists the chained links is This resource is not valid for active/active links. |
.../services/replication/links/link-name/localCandidates/tenants
Data type | Method | Use | Access | Notes |
List | GET | Retrieve a list of the HCP tenants on the system being queried that are eligible to be included in a replication link | System-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 In JSON, the name in the name/value pair that lists the tenants is |
.../services/replication/links/link-name/remoteCandidates
Data type | Method | Use | Access | Notes |
content | GET | Retrieve a list of the items on the other system involved in a replication link that are eligible to be included in the link | System-level user account with the monitor or administrator role |
.../services/replication/links/link-name/remoteCandidates/defaultNamespaceDirectories
Data type | Method | Use | Access | Notes |
List | GET | Retrieve a list of the default-namespace directories on the other system involved in a replication link that are eligible to be included in the link | System-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 In JSON, the name in the name/value pair that lists the directories is |
.../services/replication/links/link-name/remoteCandidates/chainedLinks
Data type | Method | Use | Access | Notes |
List | GET | Retrieve a list of the inbound links on the other system involved in an active/passive link that are eligible to be included in the link | System-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 In JSON, the name in the name/value pair that lists the chained links is This resource is not valid for active/active links. |
.../services/replication/links/link-name/remoteCandidates/tenants
Data type | Method | Use | Access | Notes |
List | GET | Retrieve a list of the HCP tenants on the other system involved in a replication link that are eligible to be included in the link | System-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 In JSON, the name in the name/value pair that lists the tenants is |
.../services/replication/links/link-name/schedule
Data type | Method | Use | Access | Notes |
schedule | GET | Retrieve the schedules for an active/active link or the schedule for an active/passive link | System-level user account with the monitor or administrator role | |
POST | Modify the schedules for an active/active link or the schedule for an active/passive link | System-level user account with the administrator role |