3.1 Manage the Secure API Manager Components

1. On the Dashboard, click the API Gateway cluster that you want to modify.

2. (Optional) 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. (Optional) 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. (Conditional) If you have updated one API Gateway in the API Gateway cluster, you must update all of the API Gateways.

   1. Click Actions for the API Gateway Cluster.

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

To manage API Gateways:

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

2. (Conditional) 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 the DNS name of the node, update the certificate, or update the API Gateway password.

   4. Click OK to save the changes.

   5. (Conditional) If the API Gateway is part of an API Gateway cluster, click Actions for the API Gateway Cluster, then click Update all to update all of the members of the cluster with these changes.

3. (Conditional) 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, then click OK.

   4. (Conditional) If you are not going to recreate the API Gateway object with the same configuration, delete the Secure API Manager appliance from VMware or delete the Docker container.

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.

To manage the Access Services protection rules:

1. On the appropriate API Gateway cluster, in the right corner, select Access Services.

2. To add or delete the sshd process protection rules:

   1. Click SSH.

   2. To delete an sshd process protection rule, select the appropriate protection rule in the Allow List, then click Delete.

      NOTE:You can delete the global protection rules only from the Global tab.

   3. To add an sshd protection rule, use the same procedure as when you define the sshd process protection rules.

   4. (Conditional) Click Apply if you want to save the changes but perform additional tasks in Access Services.

   5. (Conditional) Click Save if you are finished making changes for the sshd process protection rules and want to close the Access Services window.

   6. (Conditional) If you are using the Docker deployment, you must restart the Docker service by issuing the following command:

      systemctl restart docker

      NOTE:After you make a change the impacts the Docker iptables, you must restart the Docker service to move the DOCKER-USER rule priority to the top of the FORWARD chain.

3. To add or delete the API Gateway protection rules:

   1. Click API Gateway.

   2. To delete an API Gateway protection rule, select the appropriate protection rule in the Allow List, then click Delete.

      NOTE:You can delete the global protection rules only from the Global tab.

   3. To add an API Gateway protection rule, use the same procedure as when you define the API Gateway protection rules.

   4. (Conditional) Click Apply if you want to save the changes but perform additional tasks in Access Services.

   5. (Conditional) Click Save if you are finished making changes for the API Gateway protection rules and want to close the Access Services window.

   6. (Conditional) If you are using the Docker deployment, you must restart the Docker service by issuing the following command:

      systemctl restart docker

      NOTE:After you make a change that impacts the Docker iptables, you must restart the Docker service to move the DOCKER-USER rule priority to the top of the FORWARD chain.

4. To add or delete the global protection rules:

   1. Click Global.

   2. To delete a global protection rule, select the appropriate protection rule in the Allow List or Deny List, then click Delete.

      NOTE:Deleting a global protection rule, removes the protection rule from the SSH and API Gateway tabs.

   3. To add a global protection rule, use the same procedure as when you define the global protection rules.

   4. (Conditional) Click Apply if you want to save the changes but perform additional tasks in Access Services.

   5. (Conditional) Click Save if you are finished making changes for the global protection rules and want to close the Access Services window.

   6. (Conditional) If you are using the Docker deployment, you must restart the Docker service by issuing the following command:

      systemctl restart docker

      NOTE:After you make a change that impacts the Docker iptables, you must restart the Docker service to move the DOCKER-USER rule priority to the top of the FORWARD chain.