This article explains how to start the ActiveMQ Network Bridge using Rest API.
If the bridge is currently running, the request succeeds with
201. If the bridge has already been stopped, the request returns
404 MQRC_UNKNOWN_OBJECT_NAME because
the bridge object no longer exists.
To recover a stopped bridge, use the network connector's start
operation instead of the bridge operation.
Endpoint
Post /activemq/network-bridges/{nodeName}/{managerName}/{brokerName}/{connectorType}/{networkConnectorName}/{networkBridgeName}/start
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. |
connectorType |
string | Yes |
The ActiveMQ Connector type. Available values: one-way, duplex |
networkConnectorName |
string | Yes | Name of the ActiveMQ network connector to retrieve. |
networkBridgeName |
string | Yes | The ActiveMQ Network Bridge name. |
Query Parameters
| Parameter | Type | Required | Description |
jobDate |
integer | No | Schedule job date (Unix Timestamp). |
jobTags |
string | No | A comma-separated list of schedule job tags (used only with jobDate). |
validateAccessForUser |
string | No | Validates endpoint access for the specified user. |
Example Request
curl -X 'POST' \ 'http://localhost:8019/rest/v1/activemq/network-bridges/REMOTE_ACTIVEMQ/Activemq-16/DemoBroker/one-way/local-network/tcp_%2F%2F172.16.31.36_61617/start' \ -H 'accept: */*' \ -H 'Authorization: Basic <base64-encoded-credentials> \ -d ''
Request URL
http://localhost:8019/rest/v1/activemq/network-bridges/REMOTE_ACTIVEMQ/Activemq-16/DemoBroker/one-way/local-network/tcp_%2F%2F172.16.31.36_61617/start
Response Codes
| Status Code | Description |
| 201 | Object created |
| 304 | Action failed |
Example Response
-
Success Response (201-Object created): Indicates that the ActiveMQ network bridge was successfully started. No response body is returned.
Response headers:
access-control-allow-credentials: true access-control-allow-origin: http://localhost:8019 content-length: 0 date: server: vary:
-
Example Error Response(404 - Error: Not Found):
{ "type": "pcf", "messageId": "WGS0004", "message": "Not found", "explanation": "Not found record.", "action": "Requested object not exists.", "code": "2085", "codeStr": "MQRC_UNKNOWN_OBJECT_NAME" }