/cm/peers/{peerName}

Mount Point: /api/v16/cm/peers/{peerName}

The following operations are supported on this resource:

GET

Fetch information about an existing Cloudera Manager peer.

Available since API v11. Only available with Cloudera Manager Enterprise Edition.

Parameters

name description type default
peerName Name of peer to retrieve. path
type Type of peer to retrieve. If null, REPLICATION peer type will be returned. query

Response Body

element: cmPeer

Peer information.

DELETE

Delete Cloudera Manager peer.

An attempt will be made to contact the peer server, so that the configured user can be deleted.. Errors while contacting the remote server are non-fatal.

Available since API v11. Only available with Cloudera Manager Enterprise Edition.

Parameters

name description type default
peerName Name of peer to delete. path
type Type of peer to delete. If null, REPLICATION peer type will be deleted. query

Response Body

element: cmPeer

Information about the deleted peer.

GET

Fetch information about an existing Cloudera Manager peer.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Parameters

name description type default
peerName Name of peer to retrieve. path

Response Body

element: cmPeer

Peer information.

DELETE

Delete Cloudera Manager peer.

An attempt will be made to contact the peer server, so that the configured user can be deleted.. Errors while contacting the remote server are non-fatal.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Parameters

name description type default
peerName Name of peer to delete. path

Response Body

element: cmPeer

Information about the deleted peer.

PUT

Update information for a Cloudera Manager peer.

In administrator credentials are provided in the peer information, they will be used to establish new credentials with the remote server. This can be used in case the old credentials are not working anymore. An attempt will be made to delete the old credentials if new ones are successfully created.

If changing the peer's URL, an attempt will be made to contact the old Cloudera Manager to delete the existing credentials.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Parameters

name description type default
peerName Name of peer to update. path

Request Body

element: cmPeer

Updated peer information.

Response Body

element: cmPeer

The updated peer information.