ARM REST Services API

1.23.0

Overview

Statistics
48 Operations
0 Skills
Platform Category
Manage applications, clusters, server groups, alerts, and deployment actions in Anypoint Runtime Manager.

Servers

  • https://anypoint.mulesoft.com/hybrid/api/v1
  • https://{region}.anypoint.mulesoft.com/hybrid/api/v1
  • https://{region}.platform.mulesoft.com/hybrid/api/v1

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 Servers getServers

GET

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Get the registered servers information.

Query Parameters

belongsTo: string
List servers on a target.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": [ { "data": { "id": 2194, "timeCreated": 1437495853061, "timeUpdated": 1437512467554, "name": "clustering-server", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.6.1", "agentVersion": "1.1.1", "status": "DISCONNECTED", "addresses": [ { "ip": "172.16.12.169", "networkInterface": "en0" } ], "currentClusteringIp": null, "clusterId": 2195, "clusterName": "Cluster-1" } } ] }

Create Servers createServers

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Registers a server. Uses a token to retrieve the client ID and client secret. Returns: 1- Signed certificate. 2- ClientId and ClientSecret. 3- Set of URLs used by Mule.

Header Parameters

Accept: string
The return type accepted to separate from a legacy registration.
X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Request Body

json
gatewayVersion: string
signatureRequest *: string
muleLabel *: string
muleVersion: string

Response

Successful operation.
Examples
application/json
{ "clientId": "24a635ed2b1d44aa88b5e31397335b9e", "clientSecret": "57b598683dbc4b8b93d0935bcaa66892", "certificate": "-----BEGIN CERTIFICATE REQUEST-----MIIByjCCATMCAQAwgYkxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\nMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRMwEQYDVQQKEwpHb29nbGUgSW5jMR8w\n\nHQYDVQQLExZJbmZvcm1hdGlvbiBUZWNobm9sb2d5MRcwFQYDVQQDEw53d3cuZ29vZ2xlLmNvbTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEApZtYJCHJ4VpVXHfV\nIlstQTlO4qC03hjX+ZkPyvdYd1Q4+qbAeTwXmCUKYHThVRd5aXSqlPzyIBwieMZr\nWFlRQddZ1IzXAlVRDWwAo60KecqeAXnnUK+5fXoTI/UgWshre8tJ+x/TMHaQKR/J\ncIWPhqaQhsJuzZbvAdGA80BLxdMCAwEAAaAAMA0GCSqGSIb3DQEBBQUAA4GBAIhl\n4PvFq+e7ipARgI5ZM+GZx6mpCz44DTo0JkwfRDf+BtrsaC0q68eTf2XhYOsq4fkH\nQ0uA0aVog3f5iJxCa3Hp5gxbJQ6zV6kJ0TEsuaaOhEko9sdpCoPOnRBm2i/XRD2D\n6iNh8f8z0ShGsFqjDgFHyF3o+lUyj+UC6H1QW7bn\n-----END CERTIFICATE REQUEST-----", "environmentUrls": { "anypointPlatformBaseUrl": "http://anypoint.platform.base.url:8080/path", "analyticsUrl": "http://analytics:8083/path", "authProxyUrl": "http://auth.proxy:8085/path", "contractCachingServiceUrl": "http://contract.caching.service:8082/path", "mcmWebsocketUrl": "wss://mcm.websocket:8084/path", "coreServicesUrl": "http://core.services.url:8081/path" } }

Get Servers By Serverid getServersByServerid

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Get information about a server.

Path Parameters

serverId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

json
Successful operation.
id: integer
timeCreated: number
timeUpdated: number
name: string
gatewayVersion: string
agentVersion: string
status: any
currentClusteringIP: string
memberUUID: string
serverType: any
addresses: array
runtimeInformation: object
Examples
application/json
{ "data": { "id": 2194, "timeCreated": 1437495853061, "timeUpdated": 1437512467554, "name": "clustering-server", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.6.1", "agentVersion": "1.1.1", "status": "DISCONNECTED", "addresses": [ { "ip": "172.16.12.169", "networkInterface": "en0" }, { "ip": "172.16.12.169", "networkInterface": "en0" } ], "currentClusteringIp": null, "clusterId": 2195, "clusterName": "Cluster-1" } }

Patch Servers By Serverid patchServersByServerid

PATCH

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Modify a server name.

Path Parameters

serverId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Request Body

json

Response

json
Request accepted for processing.
id: integer
timeCreated: number
timeUpdated: number
name: string
gatewayVersion: string
agentVersion: string
status: any
currentClusteringIP: string
memberUUID: string
serverType: any
addresses: array
runtimeInformation: object
Examples
application/json
{ "data": { "id": 2194, "timeCreated": 1437495853061, "timeUpdated": 1437512467554, "name": "clustering-server", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.6.1", "agentVersion": "1.1.1", "status": "DISCONNECTED", "addresses": [ { "ip": "172.16.12.169", "networkInterface": "en0" } ], "currentClusteringIp": null, "clusterId": 2195, "clusterName": "Cluster-1" } }

Delete Servers By Serverid deleteServersByServerid

DELETE

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
remove the server from Runtime Manager:

Deletes related server artifacts from all deployments. Does not attempt to undeploy the server artifacts from the server. Records are simply deleted.

If the server is connected, the connection is terminated and cannot be accepted in future.

To cleanly delete a server, first:

Remove the server from its group/cluster.

Delete all deployments whose deployment target is this server.

Wait until all applications are undeployed.

Path Parameters

serverId *: string

Query Parameters

isForce: boolean

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Operation completed successfully with no content returned.

Create Servers By Serverid Actions createServersByServeridActions

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Actually performs the action on the specified runtime

Path Parameters

serverId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Request Body

json

Response

Successful operation.
Examples
application/json
{ "data": { "id": 2380, "timeCreated": 1541022133978, "timeUpdated": 1541022133978, "timeExecuted": 1541022133978, "actionType": "RENEW_CERTIFICATE", "status": "PENDING", "reason": "", "description": "" } }

Get Servers Registrationtoken getServersRegistrationtoken

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Get the registrationToken
with id =
{registrationTokenId}

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

json
Successful operation.
data *: string
Examples
application/json
{ "data": "d8fb6e7b-8dd7-4438-99e6-572c5af92dd0---1" }

Patch Servers Registrationtoken patchServersRegistrationtoken

PATCH

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Updates registrationToken.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

json
Request accepted for processing.
data *: string
Examples
application/json
{ "data": "d8fb6e7b-8dd7-4438-99e6-572c5af92dd0---1" }

Get Servergroups getServergroups

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Get a list of all registered server groups.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": [ { "id": 73, "timeCreated": 1432247776992, "timeUpdated": 1432247776992, "name": "Group2", "servers": [ { "id": 71, "timeCreated": 1432247665613, "timeUpdated": 1432301095608, "name": "Server71", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.6.2", "agentVersion": "1.0.1-SNAPSHOT", "status": "DISCONNECTED", "serverGroupId": 73, "serverGroupName": "Group2", "addresses": [ { "ip": "172.16.12.169", "networkInterface": "en0" } ] }, { "id": 72, "timeCreated": 1432247685261, "timeUpdated": 1432303178444, "name": "Server73", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.6.2", "agentVersion": "1.0.1-SNAPSHOT", "status": "DISCONNECTED", "serverGroupId": 73, "serverGroupName": "Group2", "addresses": [ { "ip": "172.16.12.168", "networkInterface": "en0" } ] } ], "type": "SERVER_GROUP", "status": "DISCONNECTED" } ] }

Create Servergroups createServergroups

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a server group from a list of servers. The servers must not belong to any other server group or cluster.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Request Body

json

Response

Resource created successfully.
Examples
application/json
{ "data": { "id": 73, "timeCreated": 1432247776992, "timeUpdated": 1432247776992, "name": "Group2", "servers": [ { "id": 71, "timeCreated": 1432247665613, "timeUpdated": 1432301095608, "name": "Server71", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.6.2", "agentVersion": "1.0.1-SNAPSHOT", "status": "DISCONNECTED", "serverGroupId": 73, "serverGroupName": "Group2", "addresses": [ { "ip": "172.16.12.169", "networkInterface": "en0" } ] }, { "id": 72, "timeCreated": 1432247685261, "timeUpdated": 1432303178444, "name": "Server73", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.6.2", "agentVersion": "1.0.1-SNAPSHOT", "status": "DISCONNECTED", "serverGroupId": 73, "serverGroupName": "Group2", "addresses": [ { "ip": "172.16.12.168", "networkInterface": "en0" } ] } ], "type": "SERVER_GROUP", "status": "DISCONNECTED" } }

Get Servergroups By Servergroupid getServergroupsByServergroupid

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Get information about a server group.

Path Parameters

serverGroupId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": "", "id": 73, "timeCreated": 1432247776992, "timeUpdated": 1432247776992, "name": "Group2", "servers": [ { "id": 71, "timeCreated": 1432247665613, "timeUpdated": 1432301095608, "name": "Server71", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.6.2", "agentVersion": "1.0.1-SNAPSHOT", "status": "DISCONNECTED", "serverGroupId": 73, "serverGroupName": "Group2", "addresses": [ { "ip": "172.16.12.169", "networkInterface": "en0" } ] }, { "id": 72, "timeCreated": 1432247685261, "timeUpdated": 1432303178444, "name": "Server73", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.6.2", "agentVersion": "1.0.1-SNAPSHOT", "status": "DISCONNECTED", "serverGroupId": 73, "serverGroupName": "Group2", "addresses": [ { "ip": "172.16.12.168", "networkInterface": "en0" } ] } ], "type": "SERVER_GROUP", "status": "DISCONNECTED" }

Patch Servergroups By Servergroupid patchServergroupsByServergroupid

PATCH

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Modify a server group. The only field that can be modified is the name of the server group.

Path Parameters

serverGroupId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.

Delete Servergroups By Servergroupid deleteServergroupsByServergroupid

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Delete a server group.

Path Parameters

serverGroupId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Request accepted for processing.

Create Servergroups By Servergroupid Servers By Serverid createServergroupsByServergroupidServersByServerid

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Add a server to a server group. Any artifacts that have been deployed to this server group also deploy to the new server. Returns the updated server.

Path Parameters

serverGroupId *: string
serverId *: string
The server ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

json
Resource created successfully.
id *: integer
timeCreated *: number
timeUpdated *: number
name *: string
servers *: array
type *: string
status *: string
Examples
application/json
{ "id": 73, "timeCreated": 1432247776992, "timeUpdated": 1432247776992, "name": "Group2", "servers": [ { "id": 71, "timeCreated": 1432247665613, "timeUpdated": 1432301095608, "name": "Server71", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.6.2", "agentVersion": "1.0.1-SNAPSHOT", "status": "DISCONNECTED", "serverGroupId": 73, "serverGroupName": "Group2", "addresses": [ { "ip": "172.16.12.169", "networkInterface": "en0" } ] }, { "id": 72, "timeCreated": 1432247685261, "timeUpdated": 1432303178444, "name": "Server73", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.6.2", "agentVersion": "1.0.1-SNAPSHOT", "status": "DISCONNECTED", "serverGroupId": 73, "serverGroupName": "Group2", "addresses": [ { "ip": "172.16.12.168", "networkInterface": "en0" } ] } ], "type": "SERVER_GROUP", "status": "DISCONNECTED" }

Delete Servergroups By Servergroupid Servers By Serverid deleteServergroupsByServergroupidServersByServerid

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Remove a server from a server group. This undeploys any artifacts from the server that are deployed to this server group.

Path Parameters

serverGroupId *: string
serverId *: string
The server ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Operation completed successfully with no content returned.

Get Clusters getClusters

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Get a list of all registered clusters.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.
Examples
application/json
[ { "id": 4, "timeCreated": 1445968023535, "timeUpdated": 1445968023535, "name": "testCluster", "multicastEnabled": false, "primaryNodeId": null, "servers": [ { "id": 2, "timeCreated": 1445967595700, "timeUpdated": 1445967683096, "name": "Mule1", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.7.1-SNAPSHOT", "agentVersion": "1.3.0-SNAPSHOT", "status": "RUNNING", "addresses": [ { "ip": "10.250.2.74", "networkInterface": "en1" } ], "currentClusteringIp": "127.0.0.1", "clusterId": 4, "clusterName": "testCluster" }, { "id": 3, "timeCreated": 1445967663477, "timeUpdated": 1445967680845, "name": "Mule2", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.7.1-SNAPSHOT", "agentVersion": "1.3.0-SNAPSHOT", "status": "RUNNING", "addresses": [ { "ip": "10.250.2.74", "networkInterface": "en1" } ], "currentClusteringIp": "127.0.0.1", "clusterId": 4, "clusterName": "testCluster" } ], "type": "CLUSTER", "visibilityMap": { "mapNodes": [ { "serverId": 2, "visibleNodeIds": [ 3 ], "unknownNodeIps": [] }, { "serverId": 3, "visibleNodeIds": [], "unknownNodeIps": [] } ] }, "status": "RUNNING" } ]

Create Clusters createClusters

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a cluster from a set of registered servers. The servers cannot already belong to another cluster or server group.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Request Body

json
name *: string
multicastEnabled *: boolean
servers *: array

Response

Resource created successfully.

Get Clusters By Clusterid getClustersByClusterid

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Get information about a cluster.

Path Parameters

clusterId *: string
The cluster ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": "", "timeCreated": 1445968023535, "timeUpdated": 1445968023535, "name": "testCluster", "multicastEnabled": false, "primaryNodeId": null, "servers": [ { "id": 2, "timeCreated": 1445967595700, "timeUpdated": 1445967683096, "name": "Mule1", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.7.1-SNAPSHOT", "agentVersion": "1.3.0-SNAPSHOT", "status": "RUNNING", "addresses": [ { "ip": "10.250.2.74", "networkInterface": "en1" } ], "currentClusteringIp": "127.0.0.1", "clusterId": 4, "clusterName": "testCluster" }, { "id": 3, "timeCreated": 1445967663477, "timeUpdated": 1445967680845, "name": "Mule2", "serverType": "MULE", "type": "SERVER", "muleVersion": "3.7.1-SNAPSHOT", "agentVersion": "1.3.0-SNAPSHOT", "status": "RUNNING", "addresses": [ { "ip": "10.250.2.74", "networkInterface": "en1" } ], "currentClusteringIp": "127.0.0.1", "clusterId": 4, "clusterName": "testCluster" } ], "type": "CLUSTER", "visibilityMap": { "mapNodes": [ { "serverId": 2, "visibleNodeIds": [ 3 ], "unknownNodeIps": [] }, { "serverId": 3, "visibleNodeIds": [], "unknownNodeIps": [] } ] }, "status": "RUNNING" }

Patch Clusters By Clusterid patchClustersByClusterid

PATCH

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Modify a cluster. The only field that can be modified is the name of the cluster.

Path Parameters

clusterId *: string
The cluster ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.

Delete Clusters By Clusterid deleteClustersByClusterid

DELETE

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Delete a cluster.

Path Parameters

clusterId *: string
The cluster ID to identify the target resource.

Query Parameters

isForce: boolean

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Request accepted for processing.

Create Clusters By Clusterid Servers createClustersByClusteridServers

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Add a server to the cluster. Any artifacts that were already deployed to this cluster also deploy to the new server. Returns the updated server. Only include the server's IP address when adding servers to a unicast cluster.

Path Parameters

clusterId *: string
The cluster ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Request Body

json
serverId *: integer
serverIp: string

Response

Request accepted for processing.

Update Clusters By Clusterid Servers By Serverid updateClustersByClusteridServersByServerid

PUT

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Modifies clustering information for a server. The server must be part of a cluster.

Path Parameters

clusterId *: string
The cluster ID to identify the target resource.
serverId *: string
The server ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Request Body

json
serverIp *: string
serverPort: integer

Response

Accepted.

Delete Clusters By Clusterid Servers By Serverid deleteClustersByClusteridServersByServerid

DELETE

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Remove server from a cluster. This undeploys any artifacts from the server that are deployed to this cluster.

Path Parameters

clusterId *: string
The cluster ID to identify the target resource.
serverId *: string
The server ID to identify the target resource.

Query Parameters

isForce: boolean

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Operation completed successfully with no content returned.

Get Targets By Targetid Components getTargetsByTargetidComponents

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieves a components.

Path Parameters

targetId *: string
The target ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.

Get Targets By Targetid Components By Componentid getTargetsByTargetidComponentsByComponentid

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Get the component
with id =
{componentId}

Path Parameters

targetId *: string
The target ID to identify the target resource.
componentId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": "", "configurableComponentId": 123, "enabled": "true", "configurationProperties": { "trackingLevel": "DEBUG" } }

Update Targets By Targetid Components By Componentid updateTargetsByTargetidComponentsByComponentid

PUT

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Replaces a components.

Path Parameters

targetId *: string
The target ID to identify the target resource.
componentId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.

Patch Targets By Targetid Components By Componentid patchTargetsByTargetidComponentsByComponentid

PATCH

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Updates a components.

Path Parameters

targetId *: string
The target ID to identify the target resource.
componentId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.

Get Applications getApplications

GET

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Get deployed applications that matches the query params.

Query Parameters

applicationId: number
Retrieves a unique application.
targetId: number
Retrieves all applications deployed to a target.
status: string
Deployment status.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": [ { "id": 42, "timeCreated": 1430777912941, "timeUpdated": 1430777916635, "serverArtifacts": [ { "id": 35, "timeCreated": 1430777912955, "timeUpdated": 1430777912955, "artifactName": "mule-app-test-54576", "artifact": { "id": 32, "type": "APPLICATION", "name": "mule-app-test-54576" }, "applicationId": 42, "serverId": 44, "lastReportedStatus": "DEPLOYING", "desiredStatus": "DEPLOYED", "message": null, "discovered": false }, { "id": 36, "timeCreated": 1430777912964, "timeUpdated": 1430777916611, "artifactName": "mule-app-test-54576", "artifact": { "id": 32, "type": "APPLICATION", "name": "mule-app-test-54576" }, "applicationId": 42, "serverId": 43, "lastReportedStatus": "DEPLOYING", "desiredStatus": "DEPLOYED", "message": null, "discovered": false } ], "desiredStatus": "STARTED", "lastReportedStatus": "STARTED", "artifact": { "id": 32, "type": "APPLICATION", "name": "mule-app-test-54576" }, "target": { "id": 45, "timeCreated": 1430777909414, "timeUpdated": 1430777918647, "name": "test-mule-group-54576", "servers": [ { "id": 44, "timeCreated": 1430777894462, "timeUpdated": 1430777910626, "name": "test-mule-2-54576", "serverType": "MULE", "muleVersion": "3.6.0", "agentVersion": "1.0.1-SNAPSHOT", "status": "DISCONNECTED", "serverGroupId": 45, "serverGroupName": "test-mule-group-54576" }, { "id": 43, "timeCreated": 1430777890063, "timeUpdated": 1430777918771, "name": "test-mule-1-54576", "serverType": "MULE", "muleVersion": "3.6.0", "agentVersion": "1.0.1-SNAPSHOT", "status": "RUNNING" } ], "discoveredArtifactNames": [], "status": "PARTIAL" } } ] }

Create Applications createApplications

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Deploy an artifact to a deployment target. Initiates deployment and creates server artifacts.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Request Body

json
targetId *: integer
artifactName *: string
applicationSource *: object | object
targetId *: integer
artifactName *: string
applicationSource *: object | object

Response

Resource created successfully.
Examples
application/json
{ "data": { "id": 42, "timeCreated": 1430777912941, "timeUpdated": 1430777916635, "serverArtifacts": [ { "id": 35, "timeCreated": 1430777912955, "timeUpdated": 1430777912955, "artifactName": "mule-app-test-54576", "artifact": { "id": 32, "type": "APPLICATION", "name": "mule-app-test-54576" }, "applicationId": 42, "serverId": 44, "lastReportedStatus": "DEPLOYING", "desiredStatus": "DEPLOYED", "message": null, "discovered": false }, { "id": 36, "timeCreated": 1430777912964, "timeUpdated": 1430777916611, "artifactName": "mule-app-test-54576", "artifact": { "id": 32, "type": "APPLICATION", "name": "mule-app-test-54576" }, "applicationId": 42, "serverId": 43, "lastReportedStatus": "DEPLOYING", "desiredStatus": "DEPLOYED", "message": null, "discovered": false } ], "desiredStatus": "STARTED", "lastReportedStatus": "STARTED", "artifact": { "id": 32, "type": "APPLICATION", "name": "mule-app-test-54576" }, "target": { "id": 45, "timeCreated": 1430777909414, "timeUpdated": 1430777918647, "name": "test-mule-group-54576", "servers": [ { "id": 44, "timeCreated": 1430777894462, "timeUpdated": 1430777910626, "name": "test-mule-2-54576", "serverType": "MULE", "muleVersion": "3.6.0", "agentVersion": "1.0.1-SNAPSHOT", "status": "DISCONNECTED", "serverGroupId": 45, "serverGroupName": "test-mule-group-54576" }, { "id": 43, "timeCreated": 1430777890063, "timeUpdated": 1430777918771, "name": "test-mule-1-54576", "serverType": "MULE", "muleVersion": "3.6.0", "agentVersion": "1.0.1-SNAPSHOT", "status": "RUNNING" } ], "discoveredArtifactNames": [], "status": "PARTIAL" } } }

Get Applications By Applicationid getApplicationsByApplicationid

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Get The application deployment and status information.

Path Parameters

applicationId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": "", "id": 42, "timeCreated": 1430777912941, "timeUpdated": 1430777916635, "serverArtifacts": [ { "id": 35, "timeCreated": 1430777912955, "timeUpdated": 1430777912955, "artifactName": "mule-app-test-54576", "artifact": { "id": 32, "type": "APPLICATION", "name": "mule-app-test-54576" }, "applicationId": 42, "serverId": 44, "lastReportedStatus": "DEPLOYING", "desiredStatus": "DEPLOYED", "message": null, "discovered": false }, { "id": 36, "timeCreated": 1430777912964, "timeUpdated": 1430777916611, "artifactName": "mule-app-test-54576", "artifact": { "id": 32, "type": "APPLICATION", "name": "mule-app-test-54576" }, "applicationId": 42, "serverId": 43, "lastReportedStatus": "DEPLOYING", "desiredStatus": "DEPLOYED", "message": null, "discovered": false } ], "desiredStatus": "STARTED", "lastReportedStatus": "STARTED", "artifact": { "id": 32, "type": "APPLICATION", "name": "mule-app-test-54576" }, "target": { "id": 45, "timeCreated": 1430777909414, "timeUpdated": 1430777918647, "name": "test-mule-group-54576", "servers": [ { "id": 44, "timeCreated": 1430777894462, "timeUpdated": 1430777910626, "name": "test-mule-2-54576", "serverType": "MULE", "muleVersion": "3.6.0", "agentVersion": "1.0.1-SNAPSHOT", "status": "DISCONNECTED", "serverGroupId": 45, "serverGroupName": "test-mule-group-54576" }, { "id": 43, "timeCreated": 1430777890063, "timeUpdated": 1430777918771, "name": "test-mule-1-54576", "serverType": "MULE", "muleVersion": "3.6.0", "agentVersion": "1.0.1-SNAPSHOT", "status": "RUNNING" } ], "discoveredArtifactNames": [], "status": "PARTIAL" } }

Patch Applications By Applicationid patchApplicationsByApplicationid

PATCH

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Redeploys the app with a new artifact. If the file is not specified in the request then Runtime Manager redeploys the same file that was already in the server. If the content type is application/json then it changes the status of the deployed application from started to stopped or from stopped to started. No other application status changes are allowed. If the file is not specified and the content-type of the request body is multipart/form-data the application is RESTARTED.

Path Parameters

applicationId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Request Body

json

Response

Successful operation.

Delete Applications By Applicationid deleteApplicationsByApplicationid

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Undeploy artifact from all servers in deployment target and delete the deployment.

Path Parameters

applicationId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Undeployment is in progress.

Get Applications By Applicationid Artifact getApplicationsByApplicationidArtifact

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Gets the artifact binary.

Path Parameters

applicationId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.

Patch Applications By Applicationid Artifact patchApplicationsByApplicationidArtifact

PATCH

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Redeploys the app with a new artifact from the provided source.

Path Parameters

applicationId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Request Body

json
applicationSource *: object | object

Response

Successful operation.

Get Applications By Applicationid Flows getApplicationsByApplicationidFlows

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets all flows in the deployment's application.

Path Parameters

applicationId *: string

Response

Successful operation.
Examples
application/json
{ "data": [ { "id": 99589, "timeCreated": 1495470996320, "timeUpdated": 1495470996320, "name": "api-main", "desiredStatus": "UNMANAGED", "defaultStatus": "STARTED", "targets": [ { "id": 54456, "lastReportedStatus": "STARTED" } ] } ] }

Create Applications By Applicationid Flows createApplicationsByApplicationidFlows

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a flows.

Path Parameters

applicationId *: string

Request Body

json

Response

Resource created successfully.
Examples
application/json
{ "data": { "id": 99589, "timeCreated": 1495470996320, "timeUpdated": 1495470996320, "name": "api-main", "desiredStatus": "UNMANAGED", "defaultStatus": "STARTED", "targets": [ { "id": 54456, "lastReportedStatus": "STARTED" } ] } }

Patch Applications By Applicationid Flows patchApplicationsByApplicationidFlows

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the flows defined in the request body.

Path Parameters

applicationId *: string

Request Body

json
items: array
Array items

Response

Configuration on the updated flows to apply.

Get Applications By Applicationid Flows By Flowid getApplicationsByApplicationidFlowsByFlowid

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets the flow with the specified ID that belongs to the deployment's application.

Path Parameters

applicationId *: string
flowId *: string

Response

Successful operation.
Examples
application/json
{ "message": "Operation completed successfully." }

Patch Applications By Applicationid Flows By Flowid patchApplicationsByApplicationidFlowsByFlowid

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the flow with the specified ID.

Path Parameters

applicationId *: string
flowId *: string

Request Body

json
desiredStatus *: string

Response

json
Applies the configuration to the updated flow.
id *: integer
timeCreated *: number
timeUpdated *: number
name *: string
desiredStatus *: string
Eventualy the flow will get the desiredStatus and will fix the flow to keep it. If the value is UNMANAGED, ARM will not force any status.
defaultStatus *: string
targets: array
Examples
application/json
{ "id": 99589, "timeCreated": 1495470996320, "timeUpdated": 1495470996320, "name": "api-main", "desiredStatus": "UNMANAGED", "defaultStatus": "STARTED", "targets": [ { "id": 54456, "lastReportedStatus": "STARTED" } ] }

Get Applications By Applicationid Schedulers getApplicationsByApplicationidSchedulers

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Gets all schedulers for an application.

Path Parameters

applicationId *: string

Response

Successful operation.
Examples
application/json
{ "data": [ [ { "id": 89, "timeCreated": 1501019185832, "timeUpdated": 1501019185833, "deploymentId": 2034727, "flowId": 1395178, "name": "polling://cronScheduler1/", "type": "CRON", "enabled": true, "expression": "0 0/1 * 1/1 * ? *", "timeZone": "America/Argentina/Buenos_Aires" }, { "id": 88, "timeCreated": 1501019185830, "timeUpdated": 1501019185832, "deploymentId": 2034727, "flowId": 1395177, "name": "polling://fixedFrequencyScheduler1/", "type": "FIXED_FREQUENCY", "enabled": true, "frequency": 2000, "startDelay": 0, "timeUnit": "MILLISECONDS" } ] ] }

Create Applications By Applicationid Schedulers createApplicationsByApplicationidSchedulers

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a schedulers.

Path Parameters

applicationId *: string

Request Body

json

Response

Resource created successfully.
Examples
application/json
{ "data": [ { "id": 89, "timeCreated": 1501019185832, "timeUpdated": 1501019185833, "deploymentId": 2034727, "flowId": 1395178, "name": "polling://cronScheduler1/", "type": "CRON", "enabled": true, "expression": "0 0/1 * 1/1 * ? *", "timeZone": "America/Argentina/Buenos_Aires" }, { "id": 88, "timeCreated": 1501019185830, "timeUpdated": 1501019185832, "deploymentId": 2034727, "flowId": 1395177, "name": "polling://fixedFrequencyScheduler1/", "type": "FIXED_FREQUENCY", "enabled": true, "frequency": 2000, "startDelay": 0, "timeUnit": "MILLISECONDS" } ] }

Patch Applications By Applicationid Schedulers patchApplicationsByApplicationidSchedulers

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the schedulers specified in the request body.

Path Parameters

applicationId *: string

Request Body

json
items: array
Array items

Response

Applies the configuration to the updated scheduler.

Get Alerts getAlerts

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Get a list of alerts.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": [ { "id": 2312, "timeCreated": 342423432142342, "timeUpdated": 342423432154342, "severity": "CRITICAL", "description": "Notify when one server of cluster 45 went down", "enabled": true, "action": { "notification": { "recipients": [ "alex.tiavo", "greg.kio" ] } }, "condition": { "resourceType": "CLUSTER", "resources": [ 45 ], "event": "DISCONNECTED" } } ] }

Create Alerts createAlerts

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates alerts.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Request Body

json

Response

Resource created successfully.
Examples
application/json
{ "data": { "id": 2312, "timeCreated": 342423432142342, "timeUpdated": 342423432154342, "severity": "CRITICAL", "description": "Notify when one server of cluster 45 went down", "enabled": true, "action": { "notification": { "recipients": [ "alex.tiavo", "greg.kio" ] } }, "condition": { "resourceType": "CLUSTER", "resources": [ 45 ], "event": "DISCONNECTED" } } }

Get Alerts By Alertid getAlertsByAlertid

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Get the alert
with id =
{alertId}

Path Parameters

alertId *: string
The alert ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": "", "id": 2312, "timeCreated": 342423432142342, "timeUpdated": 342423432154342, "severity": "CRITICAL", "description": "Notify when one server of cluster 45 went down", "enabled": true, "action": { "notification": { "recipients": [ "alex.tiavo", "greg.kio" ] } }, "condition": { "resourceType": "CLUSTER", "resources": [ 45 ], "event": "DISCONNECTED" } }

Patch Alerts By Alertid patchAlertsByAlertid

PATCH

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Updates a alerts.

Path Parameters

alertId *: string
The alert ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

json
Request accepted for processing.
id *: integer
Id of the alert stored in ARM
timeCreated *: number
timeUpdated *: number
description: string
Name of the alert free text to easy identify the alert.
enabled: boolean
severity: any
Severity level.
action *: object
condition *: object | object | object
Examples
application/json
{ "id": 2312, "timeCreated": 342423432142342, "timeUpdated": 342423432154342, "severity": "CRITICAL", "description": "Notify when one server of cluster 45 went down", "enabled": true, "action": { "notification": { "recipients": [ "alex.tiavo", "greg.kio" ] } }, "condition": { "resourceType": "CLUSTER", "resources": [ 45 ], "event": "DISCONNECTED" } }

Get Alerts By Alertid History getAlertsByAlertidHistory

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Returns a list of the alert history for this particular alert id

Path Parameters

alertId *: string
The alert ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": [ { "triggeredAt": 1559656460396, "context": { "name": "runtime-391-1100-prod", "location": "https://anypoint.mulesoft.com/cloudhub/#/console/servers/server/937779/dashboard?orgId=a9ee3922-f172-452f-8eef-5db2e685eaa1&envId=749bfc7a-6e7a-4e6c-bdde-ee021c6c71f3", "resource": "937779", "comparison": "above", "currentValue": "120" }, "severity": "CRITICAL", "condition": { "type": "server-memory", "resourceType": "server" }, "actions": [ { "state": "success", "type": "email" } ] } ] }

Get Alerts Resources By Resourceid History getAlertsResourcesByResourceidHistory

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Returns a list of the alert history for this particular resource.

Path Parameters

resourceId *: string
The resource ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string
X-ANYPNT-ORG-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": [ { "alertId": "39ae5fb8-169b-4dbd-8181-25c62f8626bd", "alertName": "test-inc", "triggeredAt": 1559656903572, "severity": "CRITICAL", "condition": { "type": "server-down", "resourceType": "server" } }, { "alertId": "fdcd12fe-98da-4ea0-9791-5487bd58dc4f", "alertName": "server-cpu", "triggeredAt": 1559656490268, "severity": "WARNING", "condition": { "type": "server-cpu", "period": "1", "operator": "GREATER_THAN", "threshold": "10", "resourceType": "server" } }, { "alertId": "cd93d291-fec4-4c80-996e-79c2170a5e6c", "alertName": "server-memory", "triggeredAt": 1559656460396, "severity": "CRITICAL", "condition": { "type": "server-memory", "period": "1", "operator": "GREATER_THAN", "threshold": "10", "resourceType": "server" } }, { "alertId": "1edfabb7-3961-4f73-97bf-6991d3896500", "alertName": "server-load", "triggeredAt": 1559656460316, "severity": "CRITICAL", "condition": { "type": "server-load-average", "period": "1", "operator": "GREATER_THAN", "threshold": "0", "resourceType": "server" } } ] }