Nav

To Classify an API (Nov 2017)

An unclassified environment is the target environment where all APIs are placed after you upgrade to the November 2017 release. APIs you upgrade from the Jul 2017 to the Nov 2017 API Manager reside in the unclassified environment. Also, any API is classified that you didn’t associate with an environment prior to moving to the Nov 2017 API Manager. You need to classify any unclassified APIs to govern or otherwise manage the APIs.

If the API is not running, follow the single-step classification process in this procedure. If the API is running, follow the two-step classification process.

Single-step Classification

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

    environment

    If you do not see a suitable environment for classification of the API, create one 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. In 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

Two-step Classification

The classification process involves the following steps when the API is running:

  • Updating the server where the API or API proxy is running.

  • Classifying the API into the suggested environment.

To Update the Server

The procedure to update the server depends on how you deployed the API. Follow instructions below for your deployment type.

Managed by Proxy Deployed through API Manager

Deployed in CloudHub

  1. In API Manager, click the API to classify.

  2. In Configure Endpoint, click Redeploy Proxy.

  3. Choose a Runtime version.

  4. Click Redeploy Proxy.

Deployed in a Standalone Runtime

To deploy a new server with Runtime Agent 1.9.x or later:

  1. In API Manager, click the API to classify.

  2. In Configure Endpoint, click Deploy Proxy.

  3. Select the Runtime with Runtime Agent 1.9.x or later.

  4. Click Redeploy Proxy.

To update an existing server:

  1. SSH into the standalone Runtime server.

  2. Download Runtime Agent 1.9.x.

  3. Update the gateway Runtime agent.

  4. Restart gateway.

Managed by a Basic Endpoint or Proxy Deployed through Runtime Manager

Deployed in CloudHub

  1. Get the environment client Id and secret:

    • Go to Access Manager.

    • Click Environments.

    • Click the environment name that you want to use.

    • Copy the Client Id and Client Secret.

  2. Update the application in CloudHub:

    • Go to the proxy application in Runtime Manager.

    • Click Settings > Properties.

    • Change the values of the following properties to the values from the Environment:

      • Anypoint.platform.client_id

      • Anypoint.platform.client_secret

      • Click Apply changes.

Deployed in standalone Mule Runtime

  1. SSH into the standalone Runtime server where the application is deployed.

  2. Download Runtime Agent 1.9.x.

  3. Update Runtime Agent.

  4. Restart Mule Runtime.

Other Deployments

Perform these steps to prepare Mule Runtime to use API environments without updating the agent or registering the server with Runtime Manager.

  1. Get the environment client Id and secret:

    • Go to Access Manager.

    • Click Environments.

    • Click the environment name that you want to use.

    • Copy the Client Id and Client Secret.

Updating an application in CloudHub

  1. Go to the proxy application in Runtime Manager.

  2. Click Settings > Properties.

  3. 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. SSH into 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.

To Complete API Classification

After updating the server, when the application is up and running again, a classification suggestion appears in the API list. Click the suggestion and follow the instructions.