Enable adapter on peer

Enables the specified adapter on the specified peer.

This topic includes the following sections:

For a video demonstration of how to use this call, see Adapter-management-API.

Request

HTTP method: POST

Request URL: https://<hostname>:<port>/baocdp/rest/adapter/enable

Header: See HTTP-request-and-response-headers for header information, such as required authentication token.

Request body properties

Property	Type	Required	Description	Values	Default value
name	String	Yes	Name of the adapter to enable You can provide multiple names (shown in the example). You can retrieve a list of adapter names using Get-all-adapters.	User-provided value Existing user-defined value	NA
version	String	Yes	Adapter type version	User-provided value	NA
revision	String	Yes	Adapter type revision	User-provided value	NA
peerName	String	Yes	Peer on which the adapter is to be enabled	User-provided value	NA

Example request JSON

{"adapters":[{
   "name": "WebServiceAdapter",
   "version":"20.16.02.00",
   "revision": "1",
   "peerName":"CDP"
},
{
  "name": "HTTPAdapter",
   "version":"20.16.02.00",
   "revision": "1",
   "peerName":"CDP"
}
]
}

Response

If successful, this method enables the specified adapter on the specified peer.

Response body properties

Property	Description
adapterId	System-generated ID for the adapter
status	Status of the request
message	Message associated with the request status

Example response JSON

{
"adapterId": "AdapterConfiguration1466676891545-17392293",
"status": "Success",
"message": "Requested adapter/s successfully enabled."
}

Status codes and messages

For more details about HTTP response codes, see HTTP response codes.

HTTP code	Message	Description
200	OK	Request succeeded
400		Bad request An error occurred while enabling the adapter.
401		Unauthorized
405		Method not allowed