Search ActiveMQ Remote Managers (API) – meshIQ

This article shows how to search for ActiveMQ remote managers using the REST API.

Search ActiveMQ Remote Managers

GET /activemq/remote-mgrs

Search for ActiveMQ remote managers using optional filters and parameters.

Example Request

curl -X 'GET' \
  'http://<hostname>:8019/rest/v1/activemq/remote-mgrs?nodeName=CMACTIVEMQ&managerName=Activemq-server' \
  -H 'accept: application/json' \
  -H 'Authorization: Basic QWRtaW46YWRtaW4='

Required Permissions

Access to query remote manager metadata.

Query Parameters

Parameter	Type	Description
`nodeName`	`string`	Wildcard node name for search.
`managerName`	`string`	Wildcard manager name for search.
`projects`	`string`	Filter by a comma-separated list of project IDs.
`filter`	`string`	Attribute-based filtering.
`order`	`string`	Ordering by attributes e.g., `managerName:asc,nodeName:desc`.
`limit`	`integer`	Limit of found objects.
`attributes`	`string`	Comma-separated list of attributes or sections to return.
`validateAccessForUser`	`string`	Whether to validate access for the user.

Response Codes

200 OK: Returns an array of matching ActiveMQRemoteMgrPojo objects.
*: Returns ErrorPojo if an error occurs.

Example Response

200 OK: Returns an array of matching ActiveMQRemoteMgrPojo objects.

[
  {
    "wgsName": "MQM",
    "nodeName": "CMACTIVEMQ",
    "managerName": "Activemq-server"
  }
]

References Information

ActiveMQRemoteMgrPojo: Represents the full definition of an ActiveMQ Remote Manager connection.
ErrorPojo: Represents a standard error response object.

Reference Articles

Using the REST API using the Navigator demo system

Performing REST API operations using the Swagger UI