This article shows how to create a new ActiveMQ queue using the REST API.
Create ActiveMQ Queue
POST /activemq/queues
Create a new ActiveMQ queue.
Example Request
curl -X 'POST' \ 'http://<hostname>:8019/rest/v1/activemq/queues' \ -H 'accept: */*' \ -H 'Authorization: Basic QWRtaW46YWRtaW4=' \ -H 'Content-Type: application/json' \ -d '{ "wgsName": "MQM", "nodeName": "CMACTIVEMQ", "managerName": "Activemq-server", "brokerName": "DemoBroker", "queueName": "iss" } 'Query Parameters
| Parameter | Type | Description |
jobDate |
int64 | Schedule job date (Unix Timestamp). |
jobTags |
string | Comma-separated job tags (used only with jobDate). |
validateAccessForUser |
string | Validate endpoint access for user. |
waitForRead |
boolean | Wait for cache update. |
Request Body
{
"wgsName": "MQM",
"nodeName": "string",
"managerName": "string",
"brokerName": "string",
"queueName": "string",
"uri": "string",
"general": {
"sendDuplicateFromStoreToDLQ": true,
"memoryLimit": 0,
"tempUsageLimit": 0,
"memoryUsagePortion": 0,
"producerFlowControl": true,
"alwaysRetroactive": true,
"blockedProducerWarningInterval": 0,
"maxProducersToAudit": 0,
"maxAuditDepth": 0,
"maxPageSize": 0,
"useCache": true,
"prioritizedMessages": true,
"options": "string",
"dlq": true,
"advancedNetworkStatisticsEnabled": true,
"advancedMessageStatisticsEnabled": true
},
"state": {
"lastUpdated": "2025-09-24T09:33:33.257Z",
"enqueueCount": 0,
"dispatchCount": 0,
"dequeueCount": 0,
"duplicateFromStoreCount": 0,
"forwardCount": 0,
"inFlightCount": 0,
expiredCount": 0,
"consumerCount": 0,
"producerCount": 0,
"queueSize": 0,
"storeMessageSize": 0,
"memoryPercentUsage": 0,
"memoryUsageByteCount": 0,
"tempUsagePercentUsage": 0,
"maxEnqueueTime": 0,
"minEnqueueTime": 0,
"averageEnqueueTime": 0,
"averageMessageSize": 0,
"maxMessageSize": 0,
"minMessageSize": 0,
"blockedSends": 0,
"averageBlockedTime": 0,
"totalBlockedTime": 0,
"maxUncommittedExceededCount": 0,
"networkEnqueues": 0,
"networkDequeues": 0,
"slowConsumerStrategy": "string",
subscriptionsCount": 0,
"enqueuedMessageBrokerInTime": 0,
"enqueuedMessageClientId": "string",
"enqueuedMessageId": "string",
"enqueuedMessageTimestamp": 0,
"dequeuedMessageBrokerInTime": 0,
"dequeuedMessageBrokerOutTime": 0,
"dequeuedMessageClientId": "string",
"dequeuedMessageId": "string",
"dequeuedMessageTimestamp": 0,
"cursorFull": true,
"cursorMemoryUsage": 0,
"cursorPercentUsage": 0,
"cacheEnabled": true,
"messageGroupsCount": 0,
"messageGroupType": "string",
"paused": true
},
"jobs": {
"totalJobCount": 0,
"scheduledJobCount": 0,
"canceledJobCount": 0,
"successJobCount": 0,
"failedJobCount": 0,
"readyJobCount": 0,
"pendingJobCount": 0,
"jobIds": ["string"]
},
"customProperties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
Response Codes
201– Object created.304– Object not created.*– Error response.
Example Response
201 – Object created.
{ "wgsName": "MQM",
"nodeName": "CMACTIVEMQ",
"managerName": "Activemq-server",
"brokerName": "DemoBroker",
"queueName": "iss"
"uri": "string",
"general": {
"sendDuplicateFromStoreToDLQ": true,
"memoryLimit": 0,
"tempUsageLimit": 0,
"memoryUsagePortion": 0,
"producerFlowControl": true,
"alwaysRetroactive": true,
"blockedProducerWarningInterval": 0,
"maxProducersToAudit": 0,
"maxAuditDepth": 0,
"maxPageSize": 0,
"useCache": true,
"prioritizedMessages": true,
"options": "string",
"dlq": true,
"advancedNetworkStatisticsEnabled": true,
"advancedMessageStatisticsEnabled": true
},
"state": {
"lastUpdated": "2025-09-24T09:33:33.257Z",
"enqueueCount": 0,
"dispatchCount": 0,
"dequeueCount": 0,
"duplicateFromStoreCount": 0,
"forwardCount": 0,
"inFlightCount": 0,
expiredCount": 0,
"consumerCount": 0,
"producerCount": 0,
"queueSize": 0,
"storeMessageSize": 0,
"memoryPercentUsage": 0,
"memoryUsageByteCount": 0,
"tempUsagePercentUsage": 0,
"maxEnqueueTime": 0,
"minEnqueueTime": 0,
"averageEnqueueTime": 0,
"averageMessageSize": 0,
"maxMessageSize": 0,
"minMessageSize": 0,
"blockedSends": 0,
"averageBlockedTime": 0,
"totalBlockedTime": 0,
"maxUncommittedExceededCount": 0,
"networkEnqueues": 0,
"networkDequeues": 0,
"slowConsumerStrategy": "string",
subscriptionsCount": 0,
"enqueuedMessageBrokerInTime": 0,
"enqueuedMessageClientId": "string",
"enqueuedMessageId": "string",
"enqueuedMessageTimestamp": 0,
"dequeuedMessageBrokerInTime": 0,
"dequeuedMessageBrokerOutTime": 0,
"dequeuedMessageClientId": "string",
"dequeuedMessageId": "string",
"dequeuedMessageTimestamp": 0,
"cursorFull": true,
"cursorMemoryUsage": 0,
"cursorPercentUsage": 0,
"cacheEnabled": true,
"messageGroupsCount": 0,
"messageGroupType": "string",
"paused": true
},
"jobs": {
"totalJobCount": 0,
"scheduledJobCount": 0,
"canceledJobCount": 0,
"successJobCount": 0,
"failedJobCount": 0,
"readyJobCount": 0,
"pendingJobCount": 0,
"jobIds": ["string"]
},
"customProperties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}Reference Articles
Using the REST API using the Navigator demo system
Performing REST API operations using the Swagger UI