---
schema_version: "1"
id: 5c85681c9f71b62c4715d6b14b0ab6cebe871f4953ed61d01ee37c162481ba81
title: Runtime Manager REST API
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/runtime-manager/runtime-manager-api.md
canonical_url: https://docs.mulesoft.com/runtime-manager/runtime-manager-api
source_site: docs.mulesoft.com
content_type: documentation
content_hash: d4d39f50a4ad7dc1030fccef3c2025908463b0e36f2c85fd1ef2ff9eb11ce776
description: MuleSoft Documentation Site
latest: true
---
---
product: Runtime Manager
keywords: cloudhub, cloudhub api, manage, api, rest
---

# Runtime Manager REST API

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

[![logo hybrid active](/mulesoft/current/en-us/_/img/icons/hybrid-cloud.svg "Hybrid")Hybrid](deployment-strategies#hybrid-deployments)[ ![logo server active](/mulesoft/current/en-us/_/img/icons/server-cloud.svg "Anypoint Platform PCE")Private Cloud Edition](deployment-strategies#anypoint-platform-private-cloud-edition)

The Runtime Manager REST API enables you to programmatically access these functions of Runtime
Manager:

- Manage servers:

  - Register a server.

  - Get a list of registered servers.

  - Get information about a server.

  - Change the server name.

  - Shut down, restart, or delete a server.

  - Renew server certificates.

  - Get a server registration token.

- Manage server groups:

  - Create a server group from a list of servers.

  - Get a list of registered server groups.

  - Get information about a server group.

  - Change the server group name.

  - Add or remove a server from a server group.

  - Delete a server group.

- Manage clusters:

  - Create a cluster.

  - Get a list of registered clusters.

  - Get information about a cluster.

  - Change the cluster name.

  - Add or remove a server from a cluster.

  - Modify clustering information for a server.

  - Delete a cluster.

- Manage app deployments on your servers:

  - Deploy, redeploy, and undeploy apps.

  - Get application deployment and status information.

  - Manage flows, schedulers, and alerts in a deployed app.

For an interactive reference of all the operations that are supported through the API, see
[Runtime Manager REST Services](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/arm-rest-services).

The Runtime Manager REST API manages only on-prem applications deployed to your servers. To manage
apps deployed to CloudHub using the API, see
[CloudHub API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/cloudhub-api/).

## Use the Runtime Manager API

To access operations in the Runtime Manager API, you must:

1.  Generate an authorization bearer token (AUTH\_BEARER\_TOKEN) to authenticate with the API.

    To get the access token, you need the Anypoint Platform username and password of a user assigned
    the Organization Administrators role. See
    [Authentication](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/minor/1.0/pages/Authentication/)
    in the
    [Access Management API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/minor/1.0/pages/home/).

    Your username specifies the environment to access. For example, if your username is `consuela`
    and the environment is `Development`, your username is `consuela@Development`. If you don’t
    specify an environment, the API defaults to `Production`.

2.  Get the organization ID (ORG\_ID).

    See the
    [`/api/me`](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/minor/1.0/console/method/%234250/)
    endpoint in the
    [Access Management API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/minor/1.0/pages/home/).

3.  Get the environment ID (ENV\_ID).

    See the
    [`/api/organizations/_ORG_ID_/environments`](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/minor/1.0/console/method/%234762/)
    endpoint in the
    [Access Management API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/minor/1.0/pages/home/).

### Get a List of Applications

To get a list of apps deployed on-premises using Runtime Manager, run the following `curl` command:

curl -X GET \\ --url https://anypoint.mulesoft.com/hybrid/api/v1/applications \\ -H 'authorization:
Bearer AUTH\_BEARER\_TOKEN' \\ -H 'X-ANYPNT-ENV-ID: ENV\_ID' \\ -H 'X-ANYPNT-ORG-ID: ORG\_ID'

## See Also

- [Servers, Server Groups, and Clusters](https://docs.mulesoft.com/runtime-manager/managing-servers)

- [Deploy to Your Servers](https://docs.mulesoft.com/runtime-manager/deploying-to-your-own-servers)

- [Manage Applications on Your Servers](https://docs.mulesoft.com/runtime-manager/managing-applications-on-your-own-servers)

- [Continuous Deployment](https://docs.mulesoft.com/runtime-manager/continuous-deployment)