ARM REST Services API

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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

Register server createServers

POST

Try it out

Header Parameters

Accept

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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

Bad Request.

Examples

application/json

{ "message": "Your request does not have the correct values" }

Forbidden. The authenticated user lacks the required permissions.

Examples

application/json

{ "message": "You don't have enough permissions to read the organization client_id." }

Resource not found

Examples

application/json

{ "message": "Invalid Resource" }

Conflict. The request conflicts with the current state of the resource.

Examples

application/json

{ "message": "Unable to process Core Services response. Returned status code: 409" }

Get server by ID getServersByServerid

GET

Try it out

Path Parameters

serverId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Get information about a server.

Path Parameters

serverId *: string

The server ID to identify the target resource.

Related Operations:

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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

Update server name patchServersByServerid

PATCH

Try it out

Path Parameters

serverId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Request Body application/json

Modify a server name.

Path Parameters

serverId *: string

The server ID to identify the target resource.

Related Operations:

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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 server deleteServersByServerid

DELETE

Try it out

Path Parameters

serverId *

Query Parameters

isForce

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

The server ID to identify the target resource.

Related Operations:

Query Parameters

isForce: boolean

variable enable/disables the function to force delete a server.

This will make a deletion without notifications to the Mule Runtime, this is more recommended in the case that server can't be deleted in a normal way

default: False

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Operation completed successfully with no content returned.

Execute server action createServersByServeridActions

POST

Try it out

Path Parameters

serverId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Request Body application/json

Actually performs the action on the specified runtime

Path Parameters

serverId *: string

The server ID to identify the target resource.

Related Operations:

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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 server registration token getServersRegistrationtoken

GET

Try it out

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Get the registrationToken
with id =
{registrationTokenId}

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

json

Successful operation.

data *: string

Examples

application/json

{ "data": "d8fb6e7b-8dd7-4438-99e6-572c5af92dd0---1" }

Refresh server registration token patchServersRegistrationtoken

PATCH

Try it out

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Updates registrationToken.

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

json

Request accepted for processing.

data *: string

Examples

application/json

{ "data": "d8fb6e7b-8dd7-4438-99e6-572c5af92dd0---1" }

List server groups getServergroups

GET

Try it out

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Get a list of all registered server groups.

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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 server group createServergroups

POST

Try it out

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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 server group by ID getServergroupsByServergroupid

GET

Try it out

Path Parameters

serverGroupId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Get information about a server group.

Path Parameters

serverGroupId *: string

The serverGroup ID to identify the target resource.

Related Operations:

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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

Update server group patchServergroupsByServergroupid

PATCH

Try it out

Path Parameters

serverGroupId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

The serverGroup ID to identify the target resource.

Related Operations:

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Successful operation.

Request accepted for processing.

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 server group deleteServergroupsByServergroupid

DELETE

Try it out

Path Parameters

serverGroupId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Delete a server group.

Path Parameters

serverGroupId *: string

The serverGroup ID to identify the target resource.

Related Operations:

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Request accepted for processing.

Add server to server group addServerToServerGroup

POST

Try it out

Path Parameters

serverGroupId *

serverId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

The serverGroup ID to identify the target resource.

Related Operations:

serverId *: string

The server ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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

Remove server from server group removeServerFromServerGroup

DELETE

Try it out

Path Parameters

serverGroupId *

serverId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

The serverGroup ID to identify the target resource.

Related Operations:

serverId *: string

The server ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Operation completed successfully with no content returned.

List clusters getClusters

GET

Try it out

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Get a list of all registered clusters.

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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 cluster createClusters

POST

Try it out

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Request Body

json

name *: string

multicastEnabled *: boolean

servers *: array

Response

Resource created successfully.

Get cluster by ID getClustersByClusterid

GET

Try it out

Path Parameters

clusterId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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

Update cluster patchClustersByClusterid

PATCH

Try it out

Path Parameters

clusterId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Successful operation.

Request accepted for processing.

items: array

Array items

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

Delete cluster deleteClustersByClusterid

DELETE

Try it out

Path Parameters

clusterId *

Query Parameters

isForce

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Delete a cluster.

Path Parameters

clusterId *: string

The cluster ID to identify the target resource.

Query Parameters

isForce: boolean

variable enable/disables the function to force delete a cluster.

This will make a deletion without notifications to the Mule Runtimes, this is more recommended in the case that cluster can't be deleted in a normal way

default: False

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Request accepted for processing.

Add server to cluster createClustersByClusteridServers

POST

Try it out

Path Parameters

clusterId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Request Body

json

serverId *: integer

serverIp: string

Response

Request accepted for processing.

Update clustered server configuration updateClusterServer

PUT

Try it out

Path Parameters

clusterId *

serverId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Request Body

json

serverIp *: string

serverPort: integer

Response

Accepted.

Bad Request.

Examples

application/json

[ { "message": "All servers of a unicast cluster must have their corresponding IP." }, { "message": "Server serverName (id: number) does not belong to Cluster clusterName (id: number)." } ]

Not Found.

Examples

application/json

[ { "message": "Server does not exist for this organization." }, { "message": "Cluster does not exist in your organization." } ]

Remove server from cluster removeServerFromCluster

DELETE

Try it out

Path Parameters

clusterId *

serverId *

Query Parameters

isForce

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

variable enable/disables function to force remove a server from cluster

This will make a deletion without notifications to the Mule Runtimes, this is more recommended in the case that server can't be removed from cluster in a normal way

default: False

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Operation completed successfully with no content returned.

List target components getTargetsByTargetidComponents

GET

Try it out

Path Parameters

targetId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Successful operation.

Get target component by ID getTargetComponent

GET

Try it out

Path Parameters

targetId *

componentId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

The component ID to identify the target resource.

Related Operations:

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

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Successful operation.

Examples

application/json

{ "data": "", "configurableComponentId": 123, "enabled": "true", "configurationProperties": { "trackingLevel": "DEBUG" } }

Replace target component replaceTargetComponent

PUT

Try it out

Path Parameters

targetId *

componentId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Replaces a components.

Path Parameters

targetId *: string

The target ID to identify the target resource.

componentId *: string

The component ID to identify the target resource.

Related Operations:

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

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Successful operation.

Update target component updateTargetComponent

PATCH

Try it out

Path Parameters

targetId *

componentId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Updates a components.

Path Parameters

targetId *: string

The target ID to identify the target resource.

componentId *: string

The component ID to identify the target resource.

Related Operations:

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

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Successful operation.

List deployed applications getApplications

GET

Try it out

Query Parameters

applicationId

targetId

status

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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

Deploy application createApplications

POST

Try it out

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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 application deployment status getApplicationsByApplicationid

GET

Try it out

Path Parameters

applicationId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Get The application deployment and status information.

Path Parameters

applicationId *: string

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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

Redeploy or change application status patchApplicationsByApplicationid

PATCH

Try it out

Path Parameters

applicationId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Request Body

json

Response

Successful operation.

Request accepted for processing.

id *: integer

timeCreated *: number

timeUpdated *: number

serverArtifacts *: array

desiredStatus *: string

artifact *: object

target *: object

lastReportedStatus *: string

Examples

application/json

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

Undeploy application deleteApplicationsByApplicationid

DELETE

Try it out

Path Parameters

applicationId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Undeploy artifact from all servers in deployment target and delete the deployment.

Path Parameters

applicationId *: string

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Undeployment is in progress.

Download application artifact binary getApplicationsByApplicationidArtifact

GET

Try it out

Path Parameters

applicationId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Gets the artifact binary.

Path Parameters

applicationId *: string

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Response

Successful operation.

Redeploy application with new artifact patchApplicationsByApplicationidArtifact

PATCH

Try it out

Path Parameters

applicationId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Request Body application/json

Redeploys the app with a new artifact from the provided source.

Path Parameters

applicationId *: string

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

Request Body

json

applicationSource *: object | object

Response

Successful operation.

List application flows getApplicationsByApplicationidFlows

GET

Try it out

Path Parameters

applicationId *

Custom Query Parameters

Custom Headers

Gets all flows in the deployment's application.

Path Parameters

applicationId *: string

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

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 application flow createApplicationsByApplicationidFlows

POST

Try it out

Path Parameters

applicationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Creates a flows.

Path Parameters

applicationId *: string

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

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

Update application flows patchApplicationsByApplicationidFlows

PATCH

Try it out

Path Parameters

applicationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates the flows defined in the request body.

Path Parameters

applicationId *: string

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

Request Body

json

items: array

Array items

Response

Configuration on the updated flows to apply.

Bad request.

Examples

application/json

{ "message": "Application must be STARTED or PARTIALLY STARTED in order to perform this action." }

Not Found.

Examples

application/json

{ "message": "Deployment does not exist in your organization" }

Get application flow by ID getApplicationFlow

GET

Try it out

Path Parameters

applicationId *

flowId *

Custom Query Parameters

Custom Headers

Gets the flow with the specified ID that belongs to the deployment's application.

Path Parameters

applicationId *: string

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

flowId *: string

The flow ID to identify the target resource.

Related Operations:

arm-rest-services#getApplicationsByApplicationidFlows.$.id citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

Response

Successful operation.

Examples

application/json

{ "message": "Operation completed successfully." }

Update application flow updateApplicationFlow

PATCH

Try it out

Path Parameters

applicationId *

flowId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates the flow with the specified ID.

Path Parameters

applicationId *: string

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

flowId *: string

The flow ID to identify the target resource.

Related Operations:

arm-rest-services#getApplicationsByApplicationidFlows.$.id citizen-platform-experience#getOrganizationsByOrganizationidFlows.$.id

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

Bad request.

Examples

application/json

{ "message": "You must provide a desiredStatus value. Possible values are: STARTED, STOPPED or UNMANAGED." }

Not Found.

Examples

application/json

{ "message": "The given flow does not exist in this deployment." }

List application schedulers getApplicationsByApplicationidSchedulers

GET

Try it out

Path Parameters

applicationId *

Custom Query Parameters

Custom Headers

Gets all schedulers for an application.

Path Parameters

applicationId *: string

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

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 application schedulers createApplicationSchedulers

POST

Try it out

Path Parameters

applicationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Creates a schedulers.

Path Parameters

applicationId *: string

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

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

Update application schedulers updateApplicationSchedulers

PATCH

Try it out

Path Parameters

applicationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates the schedulers specified in the request body.

Path Parameters

applicationId *: string

Could be an API Manager application ID or a Core Services client ID.

Related Operations:

api-platform#getOrganizationsByOrganizationidApplications.$.id arm-rest-services#getApplications.$.id

Request Body

json

items: array

Array items

id *: integer

Id of the scheduler stored in ARM

expression: string

Any valid CRON expression. Validated with the Quartz library: http://www.quartz-scheduler.org/api/2.2.1/org/quartz/CronExpression.html

timeZone: string

Any valid time zone. Validated with the java util TimeZone library: https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html.

frequency: integer

Frequency to run the scheduler.

startDelay: integer

Time to wait in order to start the shceduler.

timeUnit: string

Time unit used in the frequency and startDelay options.

enabled *:

Response

Applies the configuration to the updated scheduler.

List alerts getAlerts

GET

Try it out

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Get a list of alerts.

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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 alert createAlerts

POST

Try it out

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

Custom Query Parameters

Custom Headers

Request Body application/json

Creates alerts.

Header Parameters

X-ANYPNT-ENV-ID *: string

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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 alert by ID getAlertsByAlertid

GET

Try it out

Path Parameters

alertId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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

Update alert patchAlertsByAlertid

PATCH

Try it out

Path Parameters

alertId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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

List alert history getAlertsByAlertidHistory

GET

Try it out

Path Parameters

alertId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

X-ANYPNT-ORG-ID *: string

Identifier of the sub org where the api user is currently working.

Related Operations:

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

List alert history for resource getAlertsResourcesByResourceidHistory

GET

Try it out

Path Parameters

resourceId *

Header Parameters

X-ANYPNT-ENV-ID *

X-ANYPNT-ORG-ID *

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

Identifier of the environment where the api user is currently working.

Related Operations: