Nav

To Classify an API

After you upgrade to API Manager 2.x your APIs are placed in an unclassified environment. You need to classify unclassified APIs to govern or otherwise manage the APIs.

Even though API Manager supports tracking APIs with both organization and environment credentials, MuleSoft recommends using environment credentials since the permissions associated to them are more restrictive. You need to restart Mule Runtime after changing credentials. Restarting can cause downtime. See Advanced Classification to Configure Mule Servers with Environment Credentials (Optional) below for details on how to change them. After doing so, you may classify your API to an environment that API Manager will suggest.

Using credentials from one environment does not allow:

  • Tracking APIs from different environment

  • Tracking APIs from different organizations

If you need to track APIs in either of these ways, use organization credentials.

If you need to track APIs using environment credentials review the advanced section.

Classify the API from API Manager

  1. In API Manager, click the environment control, labeled SANDBOX, in this example:

    environment

    If you do not have a suitable environment you want to classify the API into, create the environment in Access Management.

  2. In Switch Environment, select Unclassified.

    switch environment

  3. Click Switch.

    A list of unclassified APIs appears.

    classify

  4. Click Classify.

  5. Under Target Environment, select the environment for the API from the list of environments available to you. For example, select Test.

  6. In Instance Label, optionally type a unique instance name. For example, type abc-api-1.

    In environments, APIs can have more than a single instance. Therefore, an instance name is required to uniquely identify it.

    classify instance

Advanced Classification to Configure Mule Servers with Environment Credentials (Optional)

You can use this configuration to track APIs that use environment credentials. This configuration requires a server restart.

The sections that follow help you classify your APIs depending on how you deployed proxies before migration.

API Managed by Proxy Deployed Through API Manager

If your API was deployed in Runtime Manager:

  1. From API Manager, click an API.

  2. Click Configure Endpoint > Redeploy Proxy.

  3. Specify a runtime version.

  4. Click Redeploy Proxy.

If your API was deployed in an on-premises standalone runtime:

  1. From API Manager, click an API.

  2. Click Configure Endpoint > Redeploy Proxy.

  3. Specify a runtime version for Mule Agent 1.9 and later.

  4. Click Redeploy Proxy.

To update an existing server:

  1. Use SSH to access the standalone runtime server.

  2. Download the Runtime Agent 1.9 or later.

  3. Update the Gateway runtime agent.

  4. Restart the Gateway.

Managed By Basic Endpoint Or Proxy Deployed Through Runtime Manager

If your API was deployed in Runtime Manager:

  1. Go to Access Manager.

  2. Click Environments.

  3. Click the environment name you want to use.

  4. Copy the Client ID and Client Secret.

To update an application in Runtime Manager:

  1. Go to the proxy application in Runtime Manager.

  2. Click Settings.

  3. Click Properties.

  4. Change the values of the following properties to the values from the Environment:

    • Anypoint.platform.client_id

    • Anypoint.platform.client_secret

  5. Click Apply changes.

To update an application deployed in standalone Mule Runtime:

  1. Use SSH to access the standalone runtime server where the application is deployed.

  2. Download Runtime Agent 1.9.x.

  3. Update the Runtime Agent.

  4. Restart the Mule Runtime.

Other Deployments

This section explains the manual steps needed to prepare Mule Runtime to use API environments without updating the agent or registering the server with Runtime Manager.

Getting the environment client ID and secret:

  1. Go to Access Manager.

  2. Click Environments.

  3. Click the environment name that you want to use.

  4. Copy the Client ID and Client Secret.

Updating an application in Runtime Manager:

  1. Go to the proxy application in Runtime Manager.

  2. Click Settings.

  3. Click Properties.

  4. Change the values of the following properties to the values from the environment:

    • anypoint.platform.client_id

    • anypoint.platform.client_secret

Updating standalone runtimes:

  1. Use SSH to access the runtime server that you want to update.

  2. Edit the <mule_home>/<conf>/wrapper.conf file.

  3. Change the values of the following properties to the values from the environment:

    • anypoint.platform.client_id

    • anypoint.platform.client_secret

  4. Restart Mule Runtime.

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.

+