Upload ActiveMQ Runtime Configuration (full activemq.xml file) – meshIQ

This article explains how to upload the complete ActiveMQ runtime configuration (activemq.xml) using the REST API.

Endpoint

POST /activemq/managers/{nodeName}/{managerName}/runtime-configuration/upload

Path Parameters

Parameter	Type	Required	Description
`nodeName`	string	Yes	Name of the ActiveMQ node.
`managerName`	string	Yes	Name of the ActiveMQ manager whose runtime configuration is being updated.

Query Parameters

Parameter	Type	Required	Description
`jobDate`	integer	No	Date or timestamp associated with the configuration update job.
`jobTags`	string	No	Tags associated with the configuration update job.
`validateAccessForUser`	string	No	Validates endpoint access for the specified user.

Request Body

The request body must contain the complete ActiveMQ runtime configuration in XML format. The following example shows a valid activemq.xml configuration.

<!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-->
<!-- START SNIPPET: example -->
<beans
 xmlns="http://www.springframework.org/schema/beans"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://activemq.apache.org/schema/core http://activemq.apache.org/schema/core/activemq-core.xsd">

   <!-- Allows us to use system properties as variables in this configuration file -->
<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="locations">
<value>file:${activemq.conf}/credentials.properties</value>
</property>
</bean>

   <!--
       The <broker> element is used to configure the ActiveMQ broker.
   -->
<broker xmlns="http://activemq.apache.org/schema/core" brokerName="DemoBroker" dataDirectory="${activemq.data}" useJmx="true">

       <destinationPolicy>
<policyMap>
<policyEntries>
<policyEntry topic=">" >
<!-- The constantPendingMessageLimitStrategy is used to prevent
                        slow topic consumers to block producers and affect other consumers
                        by limiting the number of messages that are retained
                        For more information, see:

                        http://activemq.apache.org/slow-consumer-handling.html

                   -->
<pendingMessageLimitStrategy>
<constantPendingMessageLimitStrategy limit="1000"/>
</pendingMessageLimitStrategy>
</policyEntry>
</policyEntries>
</policyMap>
</destinationPolicy>


       <!--
           The managementContext is used to configure how ActiveMQ is exposed in
           JMX. By default, ActiveMQ uses the MBean server that is started by
           the JVM. For more information, see:

           http://activemq.apache.org/jmx.html
    -->
<managementContext>
<managementContext createConnector="false"/>
</managementContext>

       <!--
           Configure message persistence for the broker. The default persistence
           mechanism is the KahaDB store (identified by the kahaDB tag).
           For more information, see:

           http://activemq.apache.org/persistence.html
       -->
<persistenceAdapter>
<kahaDB directory="${activemq.data}/kahadb"/>
</persistenceAdapter>


         <!--
           The systemUsage controls the maximum amount of space the broker will
           use before disabling caching and/or slowing down producers. For more information, see:
http://activemq.apache.org/producer-flow-control.html
         -->
<systemUsage>
<systemUsage>
<memoryUsage>
<memoryUsage percentOfJvmHeap="70" />
</memoryUsage>
<storeUsage>
<storeUsage limit="100 gb"/>
</storeUsage>
<tempUsage>
<tempUsage limit="50 gb"/>
</tempUsage>
</systemUsage>
</systemUsage>

       <!--
           The transport connectors expose ActiveMQ over a given protocol to
           clients and other brokers. For more information, see:

           http://activemq.apache.org/configuring-transports.html
       -->
<transportConnectors>
<!-- DOS protection, limit concurrent connections to 1000 and frame size to 100MB -->
<transportConnector name="openwire" uri="tcp://172.16.31.16:61616?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
<transportConnector name="amqp" uri="amqp://0.0.0.0:5673?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
<transportConnector name="stomp" uri="stomp://0.0.0.0:61613?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
<transportConnector name="mqtt" uri="mqtt://0.0.0.0:1883?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
<transportConnector name="ws" uri="ws://0.0.0.0:61614?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
</transportConnectors>

       <!-- destroy the spring context on shutdown to stop jetty -->
<shutdownHooks>
<bean xmlns="http://www.springframework.org/schema/beans" class="org.apache.activemq.hooks.SpringContextHook" />
</shutdownHooks>


<plugins>
<!-- 1) Authentication via JAAS LDAP -->
<jaasAuthenticationPlugin configuration="activemq"/>
<!-- 2) Authorization via LDAP group roles -->
<authorizationPlugin>
<map>
<authorizationMap>
<authorizationEntries>
<!-- Allow ldapgroup full access to all queues -->
<authorizationEntry queue=">"
                                       read="ldapgroup"
                                       write="admins,users,ldapgroup"
                                       admin="ldapgroup"/>
<!-- Allow ldapgroup full access to all topics -->
<authorizationEntry topic=">"
                                       read="ldapgroup"
                                       write="ldapgroup"
                                       admin="ldapgroup"/>
<!-- Advisory topics access (optional but useful for clients/tools) -->
<authorizationEntry topic="ActiveMQ.Advisory.>"
                                       read="ldapgroup"
                                       write="ldapgroup"
                                       admin="ldapgroup"/>
</authorizationEntries>
<!-- Temporary destinations permissions -->
<tempDestinationAuthorizationEntry>
<!-- ✅ actual entry (attributes go here) -->
<tempDestinationAuthorizationEntry read="ldapgroup" write="ldapgroup" admin="ldapgroup"/>
</tempDestinationAuthorizationEntry>
</authorizationMap>
</map>
</authorizationPlugin>
</plugins>

</broker>

  <!--
       Enable web consoles, REST and Ajax APIs and demos
       The web consoles requires by default login, you can disable this in the jetty.xml file

       Take a look at ${ACTIVEMQ_HOME}/conf/jetty.xml for more details
   -->
<import resource="jetty.xml"/>

</beans>
<!-- END SNIPPET: example -->

Request URL

http://localhost:8019/rest/v1/activemq/managers/REMOTE_ACTIVEMQ/Activemq-16/runtime-configuration/upload

Response Codes

Status Code	Description
204	Object changed
304	Object not changed

Example Response

curl -X 'POST' \
  'http://172.16.31.68:8019/rest/v1/activemq/managers/REMOTE_ACTIVEMQ/Activemq-16/runtime-configuration/upload' \
  -H 'accept: */*' \
  -H 'Authorization: Basic <base64-encoded-credentials> \
  -H 'Content-Type: application/xml' \
  -d '<!--
    Licensed to the Apache Software Foundation (ASF) under one or more
    contributor license agreements.  See the NOTICE file distributed with
    this work for additional information regarding copyright ownership.
    The ASF licenses this file to You under the Apache License, Version 2.0
    (the "License"); you may not use this file except in compliance with
    the License.  You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-->
<!-- START SNIPPET: example -->
<beans
  xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://activemq.apache.org/schema/core http://activemq.apache.org/schema/core/activemq-core.xsd">
 
    <!-- Allows us to use system properties as variables in this configuration file -->
<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="locations">
<value>file:${activemq.conf}/credentials.properties</value>
</property>
</bean>
 
    <!--
        The <broker> element is used to configure the ActiveMQ broker.
    -->
<broker xmlns="http://activemq.apache.org/schema/core" brokerName="DemoBroker" dataDirectory="${activemq.data}" useJmx="true">
 
        <destinationPolicy>
<policyMap>
<policyEntries>
<policyEntry topic=">" >
<!-- The constantPendingMessageLimitStrategy is used to prevent
                         slow topic consumers to block producers and affect other consumers
                         by limiting the number of messages that are retained
                         For more information, see:
 
                         http://activemq.apache.org/slow-consumer-handling.html
 
                    -->
<pendingMessageLimitStrategy>
<constantPendingMessageLimitStrategy limit="1000"/>
</pendingMessageLimitStrategy>
</policyEntry>
</policyEntries>
</policyMap>
</destinationPolicy>
 
 
        <!--
            The managementContext is used to configure how ActiveMQ is exposed in
            JMX. By default, ActiveMQ uses the MBean server that is started by
            the JVM. For more information, see:
 
            http://activemq.apache.org/jmx.html
	-->

<managementContext>
<managementContext createConnector="false"/>
</managementContext>
 
        <!--
            Configure message persistence for the broker. The default persistence
            mechanism is the KahaDB store (identified by the kahaDB tag).
            For more information, see:
 
            http://activemq.apache.org/persistence.html
        -->
<persistenceAdapter>
<kahaDB directory="${activemq.data}/kahadb"/>
</persistenceAdapter>
 
 
          <!--
            The systemUsage controls the maximum amount of space the broker will
            use before disabling caching and/or slowing down producers. For more information, see:
http://activemq.apache.org/producer-flow-control.html
          -->
<systemUsage>
<systemUsage>
<memoryUsage>
<memoryUsage percentOfJvmHeap="70" />
</memoryUsage>
<storeUsage>
<storeUsage limit="100 gb"/>
</storeUsage>
<tempUsage>
<tempUsage limit="50 gb"/>
</tempUsage>
</systemUsage>
</systemUsage>
 
        <!--
            The transport connectors expose ActiveMQ over a given protocol to
            clients and other brokers. For more information, see:
 
            http://activemq.apache.org/configuring-transports.html
        -->
<transportConnectors>
<!-- DOS protection, limit concurrent connections to 1000 and frame size to 100MB -->
<transportConnector name="openwire" uri="tcp://172.16.31.16:61616?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
<transportConnector name="amqp" uri="amqp://0.0.0.0:5673?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
<transportConnector name="stomp" uri="stomp://0.0.0.0:61613?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
<transportConnector name="mqtt" uri="mqtt://0.0.0.0:1883?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
<transportConnector name="ws" uri="ws://0.0.0.0:61614?maximumConnections=1000&amp;wireFormat.maxFrameSize=104857600"/>
</transportConnectors>
 
        <!-- destroy the spring context on shutdown to stop jetty -->
<shutdownHooks>
<bean xmlns="http://www.springframework.org/schema/beans" class="org.apache.activemq.hooks.SpringContextHook" />
</shutdownHooks>
 
 
<plugins>
<!-- 1) Authentication via JAAS LDAP -->
<jaasAuthenticationPlugin configuration="activemq"/>
<!-- 2) Authorization via LDAP group roles -->
<authorizationPlugin>
<map>
<authorizationMap>
<authorizationEntries>
<!-- Allow ldapgroup full access to all queues -->
<authorizationEntry queue=">"
                                        read="ldapgroup"
                                        write="admins,users,ldapgroup"
                                        admin="ldapgroup"/>
<!-- Allow ldapgroup full access to all topics -->
<authorizationEntry topic=">"
                                        read="ldapgroup"
                                        write="ldapgroup"
                                        admin="ldapgroup"/>
<!-- Advisory topics access (optional but useful for clients/tools) -->
<authorizationEntry topic="ActiveMQ.Advisory.>"
                                        read="ldapgroup"
                                        write="ldapgroup"
                                        admin="ldapgroup"/>
</authorizationEntries>
<!-- Temporary destinations permissions -->
<tempDestinationAuthorizationEntry>
<!-- ✅ actual entry (attributes go here) -->
<tempDestinationAuthorizationEntry read="ldapgroup" write="ldapgroup" admin="ldapgroup"/>
</tempDestinationAuthorizationEntry>
</authorizationMap>
</map>
</authorizationPlugin>
</plugins>
 
</broker>
 
   <!--
        Enable web consoles, REST and Ajax APIs and demos
        The web consoles requires by default login, you can disable this in the jetty.xml file
 
        Take a look at ${ACTIVEMQ_HOME}/conf/jetty.xml for more details
    -->
<import resource="jetty.xml"/>
 
</beans>
<!-- END SNIPPET: example -->'

Success Response (204-Object changed): Indicates that the ActiveMQ runtime configuration was successfully uploaded and updated. No response body is returned.

Response headers:
```
access-control-allow-credentials: true 
access-control-allow-origin: http://172.16.31.68:8019 
date: Thu,27 Aug 2026 06:15:33 GMT 
server: Jetty(10.0.22) 
vary: Origin
```

Example Error Response: 304-Object not changed

{
 "type" : "pcf",
 "messageId" : "WGS0024",
 "message" : "Object not read",
 "explanation" : "Problem on read object, check PCF code value.",
 "action" : "Resubmit request with a valid object.",
 "code" : "115001",
 "codeStr" : "EXIA_ACTIVEMQ_EXCEPTION",
 "exception" : "Provided config file hash not equals to existing file (File was modified)"
 }

Reference Articles

Using the REST API using the Navigator demo system

Performing REST API operations using the Swagger UI