# ARM REST Services API

Manage applications, clusters, server groups, alerts, and deployment actions in Anypoint Runtime Manager.

- **Version:** 1.23.0
- **Category:** Platform
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/arm-rest-services/api.yaml)

## Servers
- `https://anypoint.mulesoft.com/hybrid/api/v1`
- `https://{region}.anypoint.mulesoft.com/hybrid/api/v1`
- `https://{region}.platform.mulesoft.com/hybrid/api/v1`

## Operations (48)
### GET /servers

**Operation ID:** `getServers`
Get the registered servers information.

**Parameters:**
| `belongsTo` | query | List servers on a target. | optional |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### POST /servers

**Operation ID:** `createServers`
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.


**Parameters:**
| `Accept` | query | The return type accepted to separate from a legacy registration. | optional |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /servers/{serverId}

**Operation ID:** `getServersByServerid`
Get information about a server.

**Parameters:**
| `serverId` | query | The server ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### PATCH /servers/{serverId}

**Operation ID:** `patchServersByServerid`
Modify a server name.

**Parameters:**
| `serverId` | query | The server ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### DELETE /servers/{serverId}

**Operation ID:** `deleteServersByServerid`
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.


**Parameters:**
| `isForce` | query | 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
 | optional |
| `serverId` | query | The server ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### POST /servers/{serverId}/actions

**Operation ID:** `createServersByServeridActions`
Actually performs the action on the specified runtime

**Parameters:**
| `serverId` | query | The server ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /servers/registrationToken

**Operation ID:** `getServersRegistrationtoken`
Get the registrationToken
with id =
{registrationTokenId}


**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### PATCH /servers/registrationToken

**Operation ID:** `patchServersRegistrationtoken`
Updates registrationToken.

**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /serverGroups

**Operation ID:** `getServergroups`
Get a list of all registered server groups.

**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### POST /serverGroups

**Operation ID:** `createServergroups`
Create a server group from a list of servers. The servers must not belong to any other server group or cluster.

**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /serverGroups/{serverGroupId}

**Operation ID:** `getServergroupsByServergroupid`
Get information about a server group.

**Parameters:**
| `serverGroupId` | query | The serverGroup ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### PATCH /serverGroups/{serverGroupId}

**Operation ID:** `patchServergroupsByServergroupid`
Modify a server group. The only field that can be modified is the name of the server group.

**Parameters:**
| `serverGroupId` | query | The serverGroup ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### DELETE /serverGroups/{serverGroupId}

**Operation ID:** `deleteServergroupsByServergroupid`
Delete a server group.

**Parameters:**
| `serverGroupId` | query | The serverGroup ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### POST /serverGroups/{serverGroupId}/servers/{serverId}

**Operation ID:** `createServergroupsByServergroupidServersByServerid`
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.

**Parameters:**
| `serverGroupId` | query | The serverGroup ID to identify the target resource. | required |
| `serverId` | query | The server ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### DELETE /serverGroups/{serverGroupId}/servers/{serverId}

**Operation ID:** `deleteServergroupsByServergroupidServersByServerid`
Remove a server from a server group. This undeploys any artifacts from the server that are deployed to this server group.

**Parameters:**
| `serverGroupId` | query | The serverGroup ID to identify the target resource. | required |
| `serverId` | query | The server ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /clusters

**Operation ID:** `getClusters`
Get a list of all registered clusters.

**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### POST /clusters

**Operation ID:** `createClusters`
Create a cluster from a set of registered servers. The servers cannot already belong to another cluster or server group.

**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /clusters/{clusterId}

**Operation ID:** `getClustersByClusterid`
Get information about a cluster.

**Parameters:**
| `clusterId` | query | The cluster ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### PATCH /clusters/{clusterId}

**Operation ID:** `patchClustersByClusterid`
Modify a cluster. The only field that can be modified is the name of the cluster.

**Parameters:**
| `clusterId` | query | The cluster ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### DELETE /clusters/{clusterId}

**Operation ID:** `deleteClustersByClusterid`
Delete a cluster.

**Parameters:**
| `isForce` | query | 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
 | optional |
| `clusterId` | query | The cluster ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### POST /clusters/{clusterId}/servers

**Operation ID:** `createClustersByClusteridServers`
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.

**Parameters:**
| `clusterId` | query | The cluster ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### PUT /clusters/{clusterId}/servers/{serverId}

**Operation ID:** `updateClustersByClusteridServersByServerid`
Modifies clustering information for a server. The server must be part of a cluster.

**Parameters:**
| `clusterId` | query | The cluster ID to identify the target resource. | required |
| `serverId` | query | The server ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### DELETE /clusters/{clusterId}/servers/{serverId}

**Operation ID:** `deleteClustersByClusteridServersByServerid`
Remove server from a cluster. This undeploys any artifacts from the server that are deployed to this cluster.

**Parameters:**
| `isForce` | query | 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
 | optional |
| `clusterId` | query | The cluster ID to identify the target resource. | required |
| `serverId` | query | The server ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /targets/{targetId}/components

**Operation ID:** `getTargetsByTargetidComponents`
Retrieves a components.

**Parameters:**
| `targetId` | query | The target ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /targets/{targetId}/components/{componentId}

**Operation ID:** `getTargetsByTargetidComponentsByComponentid`
Get the component
with id =
{componentId}


**Parameters:**
| `targetId` | query | The target ID to identify the target resource. | required |
| `componentId` | query | The component ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### PUT /targets/{targetId}/components/{componentId}

**Operation ID:** `updateTargetsByTargetidComponentsByComponentid`
Replaces a components.

**Parameters:**
| `targetId` | query | The target ID to identify the target resource. | required |
| `componentId` | query | The component ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### PATCH /targets/{targetId}/components/{componentId}

**Operation ID:** `patchTargetsByTargetidComponentsByComponentid`
Updates a components.

**Parameters:**
| `targetId` | query | The target ID to identify the target resource. | required |
| `componentId` | query | The component ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /applications

**Operation ID:** `getApplications`
Get deployed applications that matches the query params.

**Parameters:**
| `applicationId` | query | Retrieves a unique application. | optional |
| `targetId` | query | Retrieves all applications deployed to a target. | optional |
| `status` | query | Deployment status. | optional |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### POST /applications

**Operation ID:** `createApplications`
Deploy an artifact to a deployment target. Initiates deployment and creates server artifacts.

**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /applications/{applicationId}

**Operation ID:** `getApplicationsByApplicationid`
Get The application deployment and status information.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### PATCH /applications/{applicationId}

**Operation ID:** `patchApplicationsByApplicationid`
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.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### DELETE /applications/{applicationId}

**Operation ID:** `deleteApplicationsByApplicationid`
Undeploy artifact from all servers in deployment target and delete the deployment.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /applications/{applicationId}/artifact

**Operation ID:** `getApplicationsByApplicationidArtifact`
Gets the artifact binary.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### PATCH /applications/{applicationId}/artifact

**Operation ID:** `patchApplicationsByApplicationidArtifact`
Redeploys the app with a new artifact from the provided source.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /applications/{applicationId}/flows

**Operation ID:** `getApplicationsByApplicationidFlows`
Gets all flows in the deployment's application.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |

### POST /applications/{applicationId}/flows

**Operation ID:** `createApplicationsByApplicationidFlows`
Creates a flows.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |

### PATCH /applications/{applicationId}/flows

**Operation ID:** `patchApplicationsByApplicationidFlows`
Updates the flows defined in the request body.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |

### GET /applications/{applicationId}/flows/{flowId}

**Operation ID:** `getApplicationsByApplicationidFlowsByFlowid`
Gets the flow with the specified ID that belongs to the deployment's application.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |

### PATCH /applications/{applicationId}/flows/{flowId}

**Operation ID:** `patchApplicationsByApplicationidFlowsByFlowid`
Updates the flow with the specified ID.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |

### GET /applications/{applicationId}/schedulers

**Operation ID:** `getApplicationsByApplicationidSchedulers`
Gets all schedulers for an application.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |

### POST /applications/{applicationId}/schedulers

**Operation ID:** `createApplicationsByApplicationidSchedulers`
Creates a schedulers.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |

### PATCH /applications/{applicationId}/schedulers

**Operation ID:** `patchApplicationsByApplicationidSchedulers`
Updates the schedulers specified in the request body.

**Parameters:**
| `applicationId` | query | Could be an API Manager application ID or a Core Services client ID. | required |

### GET /alerts

**Operation ID:** `getAlerts`
Get a list of alerts.

**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### POST /alerts

**Operation ID:** `createAlerts`
Creates alerts.

**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /alerts/{alertId}

**Operation ID:** `getAlertsByAlertid`
Get the alert
with id =
{alertId}


**Parameters:**
| `alertId` | query | The alert ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### PATCH /alerts/{alertId}

**Operation ID:** `patchAlertsByAlertid`
Updates a alerts.

**Parameters:**
| `alertId` | query | The alert ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /alerts/{alertId}/history

**Operation ID:** `getAlertsByAlertidHistory`
Returns a list of the alert history for this particular alert id

**Parameters:**
| `alertId` | query | The alert ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |

### GET /alerts/resources/{resourceId}/history

**Operation ID:** `getAlertsResourcesByResourceidHistory`
Returns a list of the alert history for this particular resource.

**Parameters:**
| `resourceId` | query | The resource ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |
| `X-ANYPNT-ORG-ID` | query | Identifier of the sub org where the api user is currently working. | required |