ReplicatorResource
Platform translation API for Backup operations
The following resources are part of this group:
- /replicator/coordinatedstartall
- /replicator/coordinatedstopall
- /replicator/emergencyReconfiguration
- /replicator/startall
- /replicator/stopall
- /replicator/systemState
- /replicator/systemStatus
- /replicator/diagnostic-mode/{diagnosticMode}
- /replicator/systemStatus/itemAgeThreshold
- /replicator/systemStatus/pollingInterval
- /replicator/systemStatus/itemAgeThreshold/{newThreshold}
- /replicator/systemStatus/pollingInterval/{newPollingInterval}
/replicator/coordinatedstartall
Mount Point: /api/replicator/coordinatedstartall
PUT
Advanced use only. Coordinated Start all replication following backup.
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
Status Codes
code | description |
---|---|
202 | Accepted |
400 | Bad Request - see Exception |
401 | Authentication required. |
403 | Authorization required - access forbidden |
/replicator/coordinatedstopall
Mount Point: /api/replicator/coordinatedstopall
PUT
Advanced use only. Coordinated Stop all replication in preperation for backup.
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
Status Codes
code | description |
---|---|
202 | Accepted |
400 | Bad Request - see Exception |
401 | Authentication required. |
403 | Authorization required - access forbidden |
/replicator/emergencyReconfiguration
Mount Point: /api/replicator/emergencyReconfiguration
POST
Advanced use only. Start Emergency Reconfiguration.
Request Body
element: | nodes |
media types: | application/xml |
(no documentation provided)
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
Status Codes
code | description |
---|---|
202 | Accepted |
400 | Bad Request - see Exception |
404 | Not Found - see Exception |
403 | Forbidden - see Exception |
401 | Authentication required. |
403 | Authorization required - access forbidden |
/replicator/startall
Mount Point: /api/replicator/startall
PUT
Advanced use only. Start all replication following backup.
Response Body
element: | (custom) |
media types: | application/xml |
(no documentation provided)
Status Codes
code | description |
---|---|
202 | Accepted |
400 | Bad Request - see Exception |
401 | Authentication required. |
403 | Authorization required - access forbidden |
/replicator/stopall
Mount Point: /api/replicator/stopall
PUT
Advanced use only. Stop all replication in preperation for backup.
Response Body
element: | (custom) |
media types: | application/xml |
(no documentation provided)
Status Codes
code | description |
---|---|
202 | Accepted |
400 | Bad Request - see Exception |
401 | Authentication required. |
403 | Authorization required - access forbidden |
/replicator/systemState
Mount Point: /api/replicator/systemState
GET
Get the System State for the replicator.
Response Body
element: | systemState |
media types: | application/xml application/json |
(no documentation provided)
Status Codes
code | description |
---|---|
200 | Ok |
401 | Authentication required. |
403 | Authorization required - access forbidden |
/replicator/systemStatus
Mount Point: /api/replicator/systemStatus
GET
Get the System State for the replicator.
Response Body
element: | (custom) |
media types: | text/plain |
(no documentation provided)
Status Codes
code | description |
---|---|
200 | Ok |
401 | Authentication required. |
403 | Authorization required - access forbidden |
/replicator/diagnostic-mode/{diagnosticMode}
Mount Point: /api/replicator/diagnostic-mode/{diagnosticMode}
PUT
Set the diagnostics mode flag Advanced use only.
Parameters
name | description | type | default |
---|---|---|---|
diagnosticMode | true/false | path |
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
Status Codes
code | description |
---|---|
200 | Ok |
400 | Bad Request - see Exception |
401 | Authentication required. |
403 | Authorization required - access forbidden |
/replicator/systemStatus/itemAgeThreshold
Mount Point: /api/replicator/systemStatus/itemAgeThreshold
GET
Get the System State Item Age Threshold for the replicator.
Response Body
element: | (custom) |
media types: | text/plain |
(no documentation provided)
Status Codes
code | description |
---|---|
200 | Ok |
401 | Authentication required. |
403 | Authorization required - access forbidden |
/replicator/systemStatus/pollingInterval
Mount Point: /api/replicator/systemStatus/pollingInterval
GET
Get the System State polling interval for the replicator.
Response Body
element: | (custom) |
media types: | text/plain |
(no documentation provided)
Status Codes
code | description |
---|---|
200 | Ok |
401 | Authentication required. |
403 | Authorization required - access forbidden |
/replicator/systemStatus/itemAgeThreshold/{newThreshold}
Mount Point: /api/replicator/systemStatus/itemAgeThreshold/{newThreshold}
PUT
Put the new System State Item Age Threshold for the replicator.
Parameters
name | description | type | default |
---|---|---|---|
newThreshold | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
Status Codes
code | description |
---|---|
401 | Authentication required. |
403 | Authorization required - access forbidden |
/replicator/systemStatus/pollingInterval/{newPollingInterval}
Mount Point: /api/replicator/systemStatus/pollingInterval/{newPollingInterval}
PUT
Put the new System State polling interval for the replicator.
Parameters
name | description | type | default |
---|---|---|---|
newPollingInterval | (no documentation provided) | path |
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
Status Codes
code | description |
---|---|
401 | Authentication required. |
403 | Authorization required - access forbidden |