---
schema_version: "1"
id: 3dbd62516e682410b5a325b70512f123ff97a64f7406c30238abeb75a1fcb4ba
title: Runtime Manager Agent API
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/runtime-manager/runtime-manager-agent-api.md
canonical_url: https://docs.mulesoft.com/runtime-manager/runtime-manager-agent-api
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 871fc2bc3acf5a684d30937ac2d626e4233b4f46503f2b5b7ffce95406353250
description: MuleSoft Documentation Site
latest: true
---
---
product: Runtime Manager
keywords: agent, mule, esb, servers, monitor, notifications, external systems, third party, get status, metrics
---

# Runtime Manager Agent API

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

[![logo hybrid active](/mulesoft/current/en-us/_/img/icons/hybrid-cloud.svg "Hybrid")Hybrid](deployment-strategies#hybrid-deployments)[ ![logo server active](/mulesoft/current/en-us/_/img/icons/server-cloud.svg "Anypoint Platform PCE")Private Cloud Edition](deployment-strategies#anypoint-platform-private-cloud-edition)

The Runtime Manager agent API enables you to manage your on-premises Mule runtime engine directly
using a REST API.

For the majority of use cases, you need only to install and configure the Runtime Manager agent. To
use the Runtime Manager agent for more than managing the communication between Runtime Manager and
on-premises Mule instances, use the Runtime Manager Agent API.

The Runtime Manager agent REST API enables you to programmatically access these functions of the
agent:

- Deploy Mule applications.

- Deploy Mule domains.

- Create a cluster of Mule servers.

- Monitor JMX beans.

- Configure system properties.

- Configure log levels.

- Configure Mule agent plugins, such as:

  - Event tracking

  - Splunk integration

  - ELK integration

For an interactive reference of all the operations that are supported through the API, see
[Runtime Manager Agent API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/mule-agent-plugin-api/minor/1.1/pages/home/)
on Exchange.

## See Also

- [Install or Update the Runtime Manager Agent](https://docs.mulesoft.com/runtime-manager/installing-and-configuring-runtime-manager-agent)

- [JMX Service](https://docs.mulesoft.com/runtime-manager/jmx-service)

- [Runtime Manager Agent Notifications](https://docs.mulesoft.com/runtime-manager/runtime-manager-agent-notifications)