ARM Mule Agent Plugin API

1.0.0

Overview

Statistics
44 Operations
0 Skills
Management Category
Manage and monitor a locally running Mule runtime instance through the Mule Agent REST API.

Servers

  • http://localhost:9999/mule

Authentication & Security

  • bearerAuth http

    Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login

  • clientAuth oauth2

    OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token

Get Agent getAgent

GET

Try it out

Custom Query Parameters
Custom Headers
Endpoint to validate the Mule Agent is listening.

Response

Successful operation.
Examples
application/json
{}

Update Agent updateAgent

PUT

Try it out

Custom Query Parameters
Custom Headers
Request Body application/octet-stream
<p>Upgrades the Mule Agent plugin with the provided .jar file.</p> <p>Upgrading the Agent will only install the the jar passed in the request and won't change any configuration</p> <p>Since v2.2.0 the configuration of Authentication Proxy and MCM endpoints was changed so in order to reconect the server further configuration would be needed</p>

Request Body

octet-stream

Response

Request accepted for processing.

Get Agent Configuration getAgentConfiguration

GET

Try it out

Custom Query Parameters
Custom Headers
Returns the full configuration of the Mule Agent.

Response

Successful operation.
Examples
application/json
{}

Get Agent Components getAgentComponents

GET

Try it out

Custom Query Parameters
Custom Headers
Returns list of components that contain the ids and status of the different external message handlers, internal message handler and services in the Mule Agent.

Response

Successful operation.
Examples
application/json
{}

Get Agent By Componentid getAgentByComponentid

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a JSON representing the component's configuration.

Path Parameters

componentId *: string

Response

json
Successful operation.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.
serviceHandlerTypes: array
The current value of the field.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.
serviceHandlerTypes: array
The current value of the field.
Examples
application/json
{ "configurableFields": [ { "id": "string", "type": "string" } ], "injectedHandlers": [ { "name": "string", "path": "string", "type": "string" } ], "serviceHandlerTypes": [ "string" ] }
application/text
{ "configurableFields": [ { "id": "string", "type": "string" } ], "injectedHandlers": [ { "name": "string", "path": "string", "type": "string" } ], "serviceHandlerTypes": [ "string" ] }

Update Agent By Componentid updateAgentByComponentid

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Changes the configuration of the component by overriding the full configuration with the
one passed in the JSON.

Path Parameters

componentId *: string

Request Body

json
serviceHandlerTypes: array
The current value of the field.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.

Response

json
Successful operation.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.
serviceHandlerTypes: array
The current value of the field.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.
serviceHandlerTypes: array
The current value of the field.
Examples
application/text
{ "configurableFields": [ { "id": "string", "type": "string" } ], "injectedHandlers": [ { "name": "string", "path": "string", "type": "string" } ], "serviceHandlerTypes": [ "string" ] }
application/json
{ "configurableFields": [ { "id": "string", "type": "string" } ], "injectedHandlers": [ { "name": "string", "path": "string", "type": "string" } ], "serviceHandlerTypes": [ "string" ] }

Patch Agent By Componentid patchAgentByComponentid

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Changes the configuration of the component by overriding the values of the properties passed
in the JSON.

Path Parameters

componentId *: string

Request Body

json
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.
serviceHandlerTypes: array
The current value of the field.

Response

json
Successful operation.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.
serviceHandlerTypes: array
The current value of the field.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.
serviceHandlerTypes: array
The current value of the field.
Examples
application/text
{ "configurableFields": [ { "id": "string", "type": "string" } ], "injectedHandlers": [ { "name": "string", "path": "string", "type": "string" } ], "serviceHandlerTypes": [ "string" ] }
application/json
{ "configurableFields": [ { "id": "string", "type": "string" } ], "injectedHandlers": [ { "name": "string", "path": "string", "type": "string" } ], "serviceHandlerTypes": [ "string" ] }

Update Agent By Componentid Enable updateAgentByComponentidEnable

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Enables a service.

Path Parameters

componentId *: string

Response

The component information.
Examples
application/json
{}
application/text
{}

Update Agent By Componentid Disable updateAgentByComponentidDisable

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Disables a service.

Path Parameters

componentId *: string

Response

The component information.
Examples
application/json
{}
application/text
{}

Update Agent By Componentid By Applicationname updateAgentByComponentidByApplicationname

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Completely changes the configuration of the service by overriding the configuration provided in the agent descriptor with the properties passed in the JSON. If the body is not sent in the request the service will respond with the current information.

Path Parameters

componentId *: string
applicationName *: string
The applicationName to identify the target resource.

Request Body

json
serviceHandlerTypes: array
The current value of the field.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.

Response

json
Successful operation.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.
serviceHandlerTypes: array
The current value of the field.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.
serviceHandlerTypes: array
The current value of the field.
Examples
application/text
{ "configurableFields": [ { "id": "string", "type": "string" } ], "injectedHandlers": [ { "name": "string", "path": "string", "type": "string" } ], "serviceHandlerTypes": [ "string" ] }
application/json
{ "configurableFields": [ { "id": "string", "type": "string" } ], "injectedHandlers": [ { "name": "string", "path": "string", "type": "string" } ], "serviceHandlerTypes": [ "string" ] }

Patch Agent By Componentid By Applicationname patchAgentByComponentidByApplicationname

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Partially changes the configuration of the service for a given application by overriding the configuration provided in the agent descriptor with the properties passed in the JSON. If the body is not sent in the request the service will respond with the current information.

Path Parameters

componentId *: string
applicationName *: string
The applicationName to identify the target resource.

Request Body

json
serviceHandlerTypes: array
The current value of the field.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.

Response

json
Successful operation.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.
serviceHandlerTypes: array
The current value of the field.
configurableFields *: array
The name of the field in the configurable component class.
injectedHandlers: array
Represents a handler that has been injected into a service.
serviceHandlerTypes: array
The current value of the field.
Examples
application/text
{ "configurableFields": [ { "id": "string", "type": "string" } ], "injectedHandlers": [ { "name": "string", "path": "string", "type": "string" } ], "serviceHandlerTypes": [ "string" ] }
application/json
{ "configurableFields": [ { "id": "string", "type": "string" } ], "injectedHandlers": [ { "name": "string", "path": "string", "type": "string" } ], "serviceHandlerTypes": [ "string" ] }

Update Actions updateActions

PUT

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Performs the action described by the request on the Runtime where the Mule Agent is running on.

Request Body

json
reason *: string
The reason of the action.
actionType *: string
id *: integer
description *: string
Description of the action
status *: string
Represents the status of a Server Action

Response

Action accepted.
Examples
application/json
{}
application/text
{}

Get Domains getDomains

GET

Try it out

Custom Query Parameters
Custom Headers
Returns all existing domains in Mule.

Response

Successful operation.
Examples
application/json
{}

Get Domains By Domainname getDomainsByDomainname

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns all the details of the domain requested.

Path Parameters

domainName *: string
The domainName to identify the target resource.

Response

Successful operation.
Examples
application/json
{}
application/text
{}

Update Domains By Domainname updateDomainsByDomainname

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Deploys or redeploys a domain in Mule

Path Parameters

domainName *: string
The domainName to identify the target resource.

Request Body

json

Response

Successful operation.
Examples
application/json
{}
application/text
{}

Delete Domains By Domainname deleteDomainsByDomainname

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Undeploys a domain from Mule.

Path Parameters

domainName *: string
The domainName to identify the target resource.

Response

Successful operation.
Examples
application/json
{}
application/text
{}

Update Domains By Domainname Restart updateDomainsByDomainnameRestart

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Restarts a domain from Mule.

Path Parameters

domainName *: string
The domainName to identify the target resource.

Response

Request accepted for processing.
Examples
application/json
{}
application/text
{}

Get Applications getApplications

GET

Try it out

Custom Query Parameters
Custom Headers
Returns all existing applications in Mule.

Response

The list of applications. The parameter state may have the values CREATED, INITIALISED, STARTED, STOPPED or DESTROYED.
Examples
application/json
{}

Get Applications By Applicationname getApplicationsByApplicationname

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets a particular application.

Path Parameters

applicationName *: string
The applicationName to identify the target resource.

Response

Successful operation.
Examples
application/json
{}
application/text
{}

Update Applications By Applicationname updateApplicationsByApplicationname

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Redeploys/creates an application to Mule using the name and file passed in the POST body.
For application/json and multipart/form-data request configures the application properties in the ${mule_home}/conf/${application-name}.yml file.

Path Parameters

applicationName *: string
The applicationName to identify the target resource.

Request Body

json

Response

The request is accepted and the application is going to be deployed/redeployed.
Examples
application/json
{}

Delete Applications By Applicationname deleteApplicationsByApplicationname

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Undeploys an application from Mule.

Path Parameters

applicationName *: string
The applicationName to identify the target resource.

Response

Request accepted for processing.
Examples
application/json
{}

Update Applications By Applicationname Stop updateApplicationsByApplicationnameStop

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Stops an application.

Path Parameters

applicationName *: string
The applicationName to identify the target resource.

Response

Successful operation.
Examples
application/json
{}

Update Applications By Applicationname Start updateApplicationsByApplicationnameStart

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Starts an application.

Path Parameters

applicationName *: string
The applicationName to identify the target resource.

Response

Successful operation.
Examples
application/json
{}

Update Applications By Applicationname Restart updateApplicationsByApplicationnameRestart

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retarts an application.

Path Parameters

applicationName *: string
The applicationName to identify the target resource.

Response

Successful operation.
Examples
application/json
{}

Get Applications By Applicationname Flows getApplicationsByApplicationnameFlows

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets application flows.

Path Parameters

applicationName *: string
The applicationName to identify the target resource.

Response

Successful operation.
Examples
application/json
{}

Update Applications By Applicationname Flows By Flowname Stop updateApplicationsByApplicationnameFlowsByFlownameStop

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Stop an application flow.

Path Parameters

applicationName *: string
The applicationName to identify the target resource.
flowName *: string
The flowName to identify the target resource.

Response

Request accepted for processing.

Update Applications By Applicationname Flows By Flowname Start updateApplicationsByApplicationnameFlowsByFlownameStart

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Start an application flow.

Path Parameters

applicationName *: string
The applicationName to identify the target resource.
flowName *: string
The flowName to identify the target resource.

Response

Request accepted for processing.

Get Clusters getClusters

GET

Try it out

Custom Query Parameters
Custom Headers
Retrieves the clustering information of this Mule instance.

Response

Successful operation.
Examples
application/json
{}
application/text
{}

Create Clusters createClusters

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Adds this Mule instance to a cluster with the information provided in the request.

Request Body

json

Response

Successful operation.
Examples
application/json
{}

Delete Clusters deleteClusters

DELETE

Try it out

Custom Query Parameters
Custom Headers
Removes this Mule instance from the cluster it belongs to.

Response

Operation completed successfully with no content returned.

Get Clusters Members getClustersMembers

GET

Try it out

Custom Query Parameters
Custom Headers
Retrieves the members of the cluster this Mule instance belongs to.

Response

Successful operation.
Examples
application/json
{}

Get Healthcheck Applications By Applicationname Ready getHealthcheckApplicationsByApplicationnameReady

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Health Check Endpoint to validate if an application is running or not.

Path Parameters

applicationName *: string
The applicationName to identify the target resource.

Response

Application Running OK

Get Logging Domains By Domainname By Scope getLoggingDomainsByDomainnameByScope

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the current log level that has the domain for a package scope.

Path Parameters

domainName *: string
The domainName to identify the target resource.
scope *: string
The scope to identify the target resource.

Response

Successful operation.
Examples
application/json
{}

Create Logging Domains By Domainname By Scope createLoggingDomainsByDomainnameByScope

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Sets the log level on a package scope for the domain passed on the request.

Path Parameters

domainName *: string
The domainName to identify the target resource.
scope *: string
The scope to identify the target resource.

Request Body

json

Response

Successful operation.

Get Logging Applications By Appname By Packagescope getLoggingApplicationsByAppnameByPackagescope

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the current log level of a package scope in an application.

Path Parameters

appName *: string
The appName to identify the target resource.
packageScope *: string
The packageScope to identify the target resource.

Response

Successful operation.
Examples
application/json
{}

Create Logging Applications By Appname By Packagescope createLoggingApplicationsByAppnameByPackagescope

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Sets the log level on a package scope for the application passed on the request.

Path Parameters

appName *: string
The appName to identify the target resource.
packageScope *: string
The packageScope to identify the target resource.

Request Body

json

Response

Successful operation.

Get Monitoring getMonitoring

GET

Try it out

Custom Query Parameters
Custom Headers
Retrieves all the beans currently being tracked by the monitoring service. Not available on PCE.

Response

Successful operation.
Examples
application/json
{}

Create Monitoring createMonitoring

POST

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Adds a list of beans to those currently being tracked the monitoring service. Not available on PCE.

Request Body

json

Response

Returns empty response.

Delete Monitoring deleteMonitoring

DELETE

Try it out

Custom Query Parameters
Custom Headers
Request Body application/json
Removes a list of beans of those currently being tracked the monitoring service. The beans to delete that are send in the json body must be identicaly the same as the registered ones. Not available on PCE.

Request Body

json

Response

Successful operation.

Get Properties getProperties

GET

Try it out

Custom Query Parameters
Custom Headers
Retrieves the server properties that are currently being set by the Mule Agent server properties.

Response

Successful operation.
Examples
application/json
{}

Create Properties createProperties

POST

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Sets the given properties in the ${mule_home}/conf/wrapper.conf file.
If override is send then it also sets Mule override value for those properties.

Query Parameters

override: boolean

Request Body

json

Response

Successful operation.
Examples
application/json
{}
application/text
{}

Get Properties By Propertyname getPropertiesByPropertyname

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the property with the given name from the ${mule_home}/conf/wrapper.conf file.

Path Parameters

propertyName *: string
The propertyName to identify the target resource.

Response

Successful operation.
Examples
application/json
{}
application/text
{}

Update Properties By Propertyname updatePropertiesByPropertyname

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Sets the given property in ${mule_home}/conf/wrapper.conf file.
If override is send then it also sets mule overrides for that property.

Path Parameters

propertyName *: string
The propertyName to identify the target resource.

Request Body

json

Response

Successful operation.
Examples
application/json
{}
application/text
{}

Delete Properties By Propertyname deletePropertiesByPropertyname

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Removes the property located in ${mule_home}/conf/wrapper.conf file.

Path Parameters

propertyName *: string
The propertyName to identify the target resource.

Response

If the operation is successfull