This article describes how to retrieve the details of an ActiveMQ network connector using the REST API.
Endpoint
GET /activemq/network-connectors/{nodeName}/{managerName}/{brokerName}/{networkConnectorName}
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
nodeName |
string | Yes | Name of the ActiveMQ node. |
managerName |
string | Yes | Name of the ActiveMQ manager that contains the specified broker. |
brokerName |
string | Yes | Name of the ActiveMQ broker that contains the specified network connector. |
networkConnectorName |
string | Yes | Name of the ActiveMQ network connector to retrieve. |
Query Parameters
| Parameter | Type | Required | Description |
attributes |
string | No | A comma-separated list of attributes or attribute sections to retrieve. |
validateAccessForUser |
string | No | Validates endpoint access for the specified user. |
Example Request
curl -X 'GET' \ 'http://localhost:8019/rest/v1/activemq/network-connectors/REMOTE_ACTIVEMQ/Activemq-16/DemoBroker/local-network' \ -H 'accept: application/json' \ -H 'Authorization: Basic <base64-encoded-credentials>'
Request URL
http://localhost:8019/rest/v1/activemq/network-connectors/REMOTE_ACTIVEMQ/Activemq-16/DemoBroker/local-network
Response Codes
| Status Code | Description |
|---|---|
| 200 | Returns matching object. |
| 404 | Error: Not Found |
Example Response
-
Success Response (200 OK): Returns the details of the specified ActiveMQ network connector.
{ "wgsName": "MQM", "nodeName": "REMOTE_ACTIVEMQ", "managerName": "Activemq-16", "brokerName": "DemoBroker", "networkConnectorName": "local-network" } -
Error Response (404 Not Found)
{ "type": "java", "messageId": "WGS0004", "message": "Not found", "explanation": "Not found record.", "action": "Requested object not exists.", "code": "2085", "codeStr": "MQRC_UNKNOWN_OBJECT_NAME" }