Runtime Manager REST API

logo cloud disabled logo hybrid active logo server active logo rtf disabled

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.

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.

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 in the Access Management API.

    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 endpoint in the Access Management API.

  3. Get the environment ID (ENV_ID).

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'

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub