ARM Mule Agent Plugin API

Get agent status getAgent

GET

Try it out

Custom Query Parameters

Custom Headers

Endpoint to validate the Mule Agent is listening.

Response

Successful operation.

Examples

application/json

{}

Upgrade Mule Agent plugin upgradeAgent

PUT

Try it out

Custom Query Parameters

Custom Headers

Request Body application/octet-stream

Upgrades the Mule Agent plugin with the provided .jar file. Upgrading the Agent will only install the the jar passed in the request and won't change any configuration 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

Request Body

octet-stream

Response

Request accepted for processing.

The JSON is invalid.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The agent resource doesn't exists.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

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

{}

List agent components listAgentComponents

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 component configuration getComponentById

GET

Try it out

Path Parameters

componentId *

Custom Query Parameters

Custom Headers

Returns a JSON representing the component's configuration.

Path Parameters

componentId *: string

The component ID to identify the target resource.

Related Operations:

arm-rest-services#getTargetsByTargetidComponents.$.id mule-agent-plugin#getAgent.$.id

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" ] }

Forbidden if the agent service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the component does not exists

Examples

application/json

{}

application/text

{}

Update component configuration updateComponent

PUT

Try it out

Path Parameters

componentId *

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

The component ID to identify the target resource.

Related Operations:

arm-rest-services#getTargetsByTargetidComponents.$.id mule-agent-plugin#getAgent.$.id

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" ] }

The JSON is invalid.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Forbidden if the agent service or external handler is disabled.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the component does not exists

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Patch component configuration patchComponent

PATCH

Try it out

Path Parameters

componentId *

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

The component ID to identify the target resource.

Related Operations:

arm-rest-services#getTargetsByTargetidComponents.$.id mule-agent-plugin#getAgent.$.id

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" ] }

Forbidden if the agent service or external handler is disabled.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the component does not exists

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Enable component enableComponent

PUT

Try it out

Path Parameters

componentId *

Custom Query Parameters

Custom Headers

Enables a service.

Path Parameters

componentId *: string

The component ID to identify the target resource.

Related Operations:

arm-rest-services#getTargetsByTargetidComponents.$.id mule-agent-plugin#getAgent.$.id

Response

The component information.

Examples

application/json

{}

application/text

{}

Forbidden if the enable service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the component does not exists

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Disable component disableComponent

PUT

Try it out

Path Parameters

componentId *

Custom Query Parameters

Custom Headers

Disables a service.

Path Parameters

componentId *: string

The component ID to identify the target resource.

Related Operations:

arm-rest-services#getTargetsByTargetidComponents.$.id mule-agent-plugin#getAgent.$.id

Response

The component information.

Examples

application/json

{}

application/text

{}

Forbidden if the disable service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the component does not exists

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Update component config for application updateComponentForApp

PUT

Try it out

Path Parameters

componentId *

applicationName *

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

The component ID to identify the target resource.

Related Operations:

arm-rest-services#getTargetsByTargetidComponents.$.id mule-agent-plugin#getAgent.$.id

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" ] }

Forbidden if the agent service or external handler is disabled.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the component does not exists

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Patch component config for application patchComponentForApp

PATCH

Try it out

Path Parameters

componentId *

applicationName *

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

The component ID to identify the target resource.

Related Operations:

arm-rest-services#getTargetsByTargetidComponents.$.id mule-agent-plugin#getAgent.$.id

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" ] }

Forbidden if the agent service or external handler is disabled.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the component does not exists

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Perform runtime action performAction

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

The type of Action to be performed on the runtime. <ul> <li>RESTART: Will restart the runtime.</li> <li>SHUTDOWN: Will shutdown the runtime.</li> <li>RENEW_CERTIFICATE: Will renew the runtime certificate ${mule_home}/conf/mule-agent.jks but only if it hasn't expired.</li> </ul>

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

{}

If there is a missing or wrong parameter in the request

Examples

application/json

{}

application/text

{}

Forbidden if the action service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

The action resource doesn't exists.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

List domains listDomains

GET

Try it out

Custom Query Parameters

Custom Headers

Returns all existing domains in Mule.

Response

Successful operation.

Examples

application/json

{}

Get domain details getDomain

GET

Try it out

Path Parameters

domainName *

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

{}

Forbidden if the domain service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the component does not exists

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Deploy or redeploy domain deployDomain

PUT

Try it out

Path Parameters

domainName *

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

{}

Forbidden if the domain service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the component does not exists

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Undeploy domain undeployDomain

DELETE

Try it out

Path Parameters

domainName *

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

{}

Forbidden if the domain service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the component does not exists

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Restart domain restartDomain

PUT

Try it out

Path Parameters

domainName *

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

{}

Forbidden if the restart service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the component does not exists

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

List applications listApplications

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

{}

If there are no applications in the Mule.

Forbidden if the application service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Get application details getApplication

GET

Try it out

Path Parameters

applicationName *

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

{}

Forbidden if the application service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the application does not exists

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Deploy or redeploy application deployApplication

PUT

Try it out

Path Parameters

applicationName *

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

{}

Forbidden if the application service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The application resource doesn't exists.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Undeploy application undeployApplication

DELETE

Try it out

Path Parameters

applicationName *

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

{}

Forbidden if the application service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The application resource doesn't exists.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Stop application stopApplication

PUT

Try it out

Path Parameters

applicationName *

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

{}

Forbidden if the stop service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The stop resource doesn't exists.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The application is already stopped.

Examples

application/json

{}

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Start application startApplication

PUT

Try it out

Path Parameters

applicationName *

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

{}

Forbidden if the start service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The start resource doesn't exists.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The application is already stopped.

Examples

application/json

{}

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Restart application restartApplication

PUT

Try it out

Path Parameters

applicationName *

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

{}

Forbidden if the restart service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The restart resource doesn't exists.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

List application flows listApplicationFlows

GET

Try it out

Path Parameters

applicationName *

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

{}

Forbidden if the flow service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The flow resource doesn't exists.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Stop application flow stopApplicationFlow

PUT

Try it out

Path Parameters

applicationName *

flowName *

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.

Forbidden if the stop service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The stop resource doesn't exists.

Examples

application/json

{}

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Start application flow startApplicationFlow

PUT

Try it out

Path Parameters

applicationName *

flowName *

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.

Forbidden if the start service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The start resource doesn't exists.

Examples

application/json

{}

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Get cluster info getClusterInfo

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

{}

If there is no cluster configuration

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Join cluster joinCluster

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

{}

The JSON is invalid.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Leave cluster leaveCluster

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.

The JSON is invalid.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

List cluster members listClusterMembers

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

{}

The member resource doesn't exists.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Check application readiness checkApplicationReady

GET

Try it out

Path Parameters

applicationName *

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

Application with the name specified not found

Conflict. Application with the name specified is not running

Examples

application/json

{}

Get domain log level getDomainLogLevel

GET

Try it out

Path Parameters

domainName *

scope *

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

{}

The JSON is invalid.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Forbidden if the domain service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the domain is not found.

Examples

application/json

{}

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Set domain log level setDomainLogLevel

POST

Try it out

Path Parameters

domainName *

scope *

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.

If there is an exception while trying to parse the json body

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Forbidden if the domain service or external handler is disabled.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the domain is not found.

Examples

application/text

{}

application/json

{}

The operation fails.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Get application log level getApplicationLogLevel

GET

Try it out

Path Parameters

appName *

packageScope *

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

{}

The JSON is invalid.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Forbidden if the application service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The application resource doesn't exists.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Set application log level setApplicationLogLevel

POST

Try it out

Path Parameters

appName *

packageScope *

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.

The JSON is invalid.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Forbidden if the application service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The application resource doesn't exists.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

List monitored beans listMonitoredBeans

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

{}

Forbidden if the monitoring service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Add monitored beans addMonitoredBeans

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.

If there is an exception while trying to parse the json body

Examples

application/text

{}

application/json

{}

Forbidden if the monitoring service or external handler is disabled.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

If one of the beans to add is already registered.

Examples

application/text

{}

application/json

{}

The operation fails.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Remove monitored beans removeMonitoredBeans

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.

If there is an exception while trying to parse the json body

Examples

application/json

{}

application/text

{}

Forbidden if the monitoring service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

If one of the beans to delete is not registered.

Examples

application/json

{}

application/text

{}

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

List server properties listProperties

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

{}

Forbidden if the property service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Set server properties setProperties

POST

Try it out

Query Parameters

override

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

Whether to set a Mule override for the given properties.

default: True

Request Body

json

Response

Successful operation.

Examples

application/json

{}

application/text

{}

If there is an exception while trying to parse the json body

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Forbidden if the property service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Get server property getProperty

GET

Try it out

Path Parameters

propertyName *

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

{}

The JSON is invalid.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Forbidden if the property service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

If the property does not exists

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Set server property setProperty

PUT

Try it out

Path Parameters

propertyName *

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

{}

If there is an exception while trying to parse the json body

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Forbidden if the property service or external handler is disabled.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

The property resource doesn't exists.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

Delete server property deleteProperty

DELETE

Try it out

Path Parameters

propertyName *

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

If there is an exception while trying to parse the json body

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Forbidden if the property service or external handler is disabled.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The property resource doesn't exists.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

The operation fails.

Examples

application/text

{ "errorType": "errorType", "errorMessage": "Error Message" }

application/json

{ "errorType": "errorType", "errorMessage": "Error Message" }

Overview

Servers

Authentication & Security

Get agent status getAgent

Try it out

Response

Response

Upgrade Mule Agent plugin upgradeAgent

Try it out

Response

Request Body

Response

Get agent configuration getAgentConfiguration

Try it out

Response

Response

List agent components listAgentComponents

Try it out

Response

Response

Get component configuration getComponentById

Try it out

Response

Path Parameters

Response

Update component configuration updateComponent

Try it out

Response

Path Parameters

Request Body

Response

Patch component configuration patchComponent

Try it out

Response

Path Parameters

Request Body

Response

Enable component enableComponent

Try it out

Response

Path Parameters

Response

Disable component disableComponent

Try it out

Response

Path Parameters

Response

Update component config for application updateComponentForApp

Try it out

Response

Path Parameters

Request Body

Response

Patch component config for application patchComponentForApp

Try it out

Response

Path Parameters

Request Body

Response

Perform runtime action performAction

Try it out

Response

Request Body

Response

List domains listDomains

Try it out

Response

Response

Get domain details getDomain

Try it out

Response

Path Parameters

Response

Deploy or redeploy domain deployDomain

Try it out

Response

Path Parameters

Request Body

Response