ReplicationGroupsResource

Platform application API for Replication Groups

The following resources are part of this group:

/replication-groups

Mount Point: /api/replication-groups

GET

Return list of all ReplicationGroups

Parameters

name description type default
withPendingTransactions (no documentation provided) query false

Response Body

element: replicationgrouplist
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

POST

Create ReplicationGroup

Request Body

element: replicationGroup
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
401 Authentication required.
403 Authorization required - access forbidden

/replication-groups/allUniqueReplicationGroupsAssociatedWithNodes

Mount Point: /api/replication-groups/allUniqueReplicationGroupsAssociatedWithNodes

GET

Returns all unique replication groups associated with the node list

Parameters

name description type default
nodeId (no documentation provided) query
withPendingTransactions (no documentation provided) query false

Response Body

element: replicationgrouplist
media types: application/xml

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception
404 Not Found - see Exception
401 Authentication required.
403 Authorization required - access forbidden

/replication-groups/allUniqueReplicationGroupsAssociatedWithRepositoryIds

Mount Point: /api/replication-groups/allUniqueReplicationGroupsAssociatedWithRepositoryIds

GET

Return unique replication groups associated with given repository ids

Parameters

name description type default
repositoryIds (no documentation provided) query
withPendingTransactions (no documentation provided) query false

Response Body

element: replicationgrouplist
media types: application/xml

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception
404 Not Found - see Exception
401 Authentication required.
403 Authorization required - access forbidden

/replication-groups/search

Mount Point: /api/replication-groups/search

GET

Search ReplicationGroups based on combination of parameters

Parameters

name description type default
groupName (no documentation provided) query
nodeId (no documentation provided) query
replicationGroupIds (no documentation provided) query
withPendingTransactions (no documentation provided) query false

Response Body

element: replicationgrouplist
media types: application/xml

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception
404 Not Found - see Exception
401 Authentication required.
403 Authorization required - access forbidden

/replication-groups/{replicationGroupId}

Mount Point: /api/replication-groups/{replicationGroupId}

GET

Return ReplicationGroup identified by Id

Parameters

name description type default
replicationGroupId (no documentation provided) path
withPendingTransactions (no documentation provided) query false

Response Body

element: replicationGroup
media types: application/xml

(no documentation provided)

Status Codes

code description
200 Ok
400 Bad Request - see Exception
404 Not Found - see Exception
401 Authentication required.
403 Authorization required - access forbidden

DELETE

Delete ReplicationGroup

Parameters

name description type default
replicationGroupId (no documentation provided) path

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
401 Authentication required.
403 Authorization required - access forbidden

/replication-groups/{replicationGroupId}/addNewNodes

Mount Point: /api/replication-groups/{replicationGroupId}/addNewNodes

POST

Add the listed nodes to the replication group

Parameters

name description type default
replicationGroupId (no documentation provided) path

Request Body

element: replicationGroupSchedule
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
401 Authentication required.
403 Authorization required - access forbidden

/replication-groups/{replicationGroupId}/removeNodes

Mount Point: /api/replication-groups/{replicationGroupId}/removeNodes

PUT

Remove the specified nodes from the replication group. Requires at least ALL OFFLINE nodes to be in the list provided.

Parameters

name description type default
replicationGroupId (no documentation provided) path
autoConfigure (no documentation provided) query false

Request Body

element: nodes
media types: application/xml
application/json

(no documentation provided)

Response Body

element: (custom)
media types: application/xml
application/json

(no documentation provided)

Status Codes

code description
202 Accepted
400 Bad Request - see Exception
404 Not Found - see Exception
401 Authentication required.
403 Authorization required - access forbidden

/replication-groups/{replicationGroupId}/schedule

Mount Point: /api/replication-groups/{replicationGroupId}/schedule

PUT

Update the Replication Group schedule

Parameters

name description type default
replicationGroupId (no documentation provided) path

Request Body

element: replicationGroupSchedule
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
401 Authentication required.
403 Authorization required - access forbidden

/replication-groups/{replicationGroupId}/groupName/{name}

Mount Point: /api/replication-groups/{replicationGroupId}/groupName/{name}

PUT

Update the replication group name

Parameters

name description type default
replicationGroupId (no documentation provided) path
name (no documentation provided) path

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
401 Authentication required.
403 Authorization required - access forbidden

/replication-groups/{replicationGroupId}/managingNode/{managingNodeId}

Mount Point: /api/replication-groups/{replicationGroupId}/managingNode/{managingNodeId}

PUT

Update the Replication Group managing node

Parameters

name description type default
replicationGroupId (no documentation provided) path
managingNodeId (no documentation provided) path

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
401 Authentication required.
403 Authorization required - access forbidden

/replication-groups/{replicationGroupId}/node/{nodeId}

Mount Point: /api/replication-groups/{replicationGroupId}/node/{nodeId}

DELETE

Remove the specified node from the replication group.

Parameters

name description type default
replicationGroupId (no documentation provided) path
nodeId (no documentation provided) path
autoConfigure (no documentation provided) query false

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
401 Authentication required.
403 Authorization required - access forbidden

/replication-groups/{replicationGroupId}/scheduleSuspended/{suspended}

Mount Point: /api/replication-groups/{replicationGroupId}/scheduleSuspended/{suspended}

PUT

Update the Replication Group schedule status

Parameters

name description type default
replicationGroupId (no documentation provided) path
suspended (no documentation provided) path

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
401 Authentication required.
403 Authorization required - access forbidden