3.1 Manage the Secure API Manager Components

Access Manager Administration Console > Dashboard > API Gateway Cluster

After you have created the Secure API Manager components, new options appear in the Access Manager Administration Console that allow you to manage the API Gateway clusters, the API Gateways, and the limiting policies.

3.1.1 Manage the API Gateway Clusters

You can rename the API Gateway cluster, delete the API Gateway cluster, and update all of the API Gateways in the selected API Gateway cluster. If you edit the configuration of an API Gateway, you must update all of the API Gateways in the API Gateway cluster to make each node in the cluster aware of the changes. You can also view the auditing information for the API cluster as well.

  1. On the Dashboard, click the appropriate API Gateway cluster to modify.

  2. To rename the API Gateway cluster:

    1. Double-click the name of the API Gateway cluster.

    2. Make the name change.

    3. Click anywhere outside of the name field and the Administration Console saves the new name.

  3. To delete the API Gateway cluster:

    1. In the upper right corner of the API Gateway cluster, click Actions.

    2. Click Delete.

    3. Read the message that explains that all API Gateways and limiting policies associated with this API Gateway cluster are automatically deleted when you delete the API Gateway cluster.

    4. Click OK. The Administration Console deletes the API Gateway cluster and all associated objects.

  4. To update all API Gateways in the API Gateway cluster:

    1. In the upper right corner of the API Gateway cluster, click Actions.

    2. Click Update all. The Administration Console updates all of the API Gateways in this API Gateway cluster with any modifications you have made to a specific API Gateway.

3.1.2 Manage the API Gateways

You can edit, update, and delete the API Gateways. Editing allows you to change any of the configuration options, including the certificate and the network configuration options. If you make any changes to an API Gateway, you can update the API Gateway only if you did not cluster the API Gateways. If you do have more than one appliance in your cluster you must update all of the API Gateways in the cluster to ensure that all of the API Gateways in the cluster have the same information for high availability.

IMPORTANT:Always delete the API Gateway object if you delete the Secure API Manager appliance from VMware. If you do not and redeploy the appliance with the same networking configuration, causes issues for the API Gateway to the point it will not function.

To manage an API Gateways:

  1. On the Dashboard, click the name of the appropriate API Gateway that you want to manage.

  2. To update the API Gateway:

    1. In the upper right corner of the API Gateway, click Actions.

    2. Click Update.

  3. To edit the API Gateway:

    1. In the upper right corner of the API Gateway, click Actions.

    2. Click Edit.

    3. Change the name, the IP address or DNS name of the appliance, update the certificate, or update the vaadmin password.

    4. Click OK to save the changes.

    5. Click Actions for the API Gateway Cluster.

    6. Click Update all to update all other members of the cluster with these changes.

  4. To delete the API Gateway:

    1. In the upper right corner of the API Gateway, click Actions.

    2. Click Delete.

    3. Read the confirmation message that you want to delete the API Gateway and all associated APIs, the click OK.

    4. (Conditional) Delete the Secure API Manager appliance from VMware if you are not going to recreate the API Gateway object with the same configuration.

3.1.3 Manage the Limiting Policies

You can edit and delete the limiting policies through the Access Manager Administration Console. By default, Secure API Manager creates an Unlimited policy that allows full access to the APIs and the API endpoints associated with the APIs that use this policy.

To manage the limiting policies:

  1. On the Dashboard, click the API Gateway cluster that contains the limiting policies you want to manage.

  2. To edit a policy:

    1. In the upper right corner of the policy, click Actions.

    2. Click Edit.

    3. Change the policy name, or the details for limiting policy details.

    4. Click OK to save the changes.