Working with Deployed Endpoints

Gateway Managers can use the Management Portal to view deployed APIs’ details, deploy, redeploy, or undeploy APIs, and approve or reject deployment requests.

Topics

• Viewing API Details

• Deploying or Redeploying an API Endpoint to a Gateway

• Approving an API Deployment Request

• Undeploying an API

Viewing API Details

You can view the API Request URL, the policies configured for the API, and the service request URL for APIs on your gateway. Gateway Managers must be issued the View All Details or Deploy API grant for an API to view its details.

To view a deployed API’s details:

1. From the Gateways List page, select a gateway.
2. Click the (Deployments) tab for the gateway.
3. Click the tab corresponding to the API’s state on the gateway:
   • Deployed: Lists APIs currently deployed to the gateway.
   • Requesting: Lists APIs requesting deployment to the gateway.
   • Waiting: Lists APIs pending deployment to the gateway.
   • Rejected: Lists API deployments rejected by a gateway manager.
   • Failed: Lists failed API deployments.
4. Click the name of the API for which you want to view details, or click the Expand icon.
   The Request and Response flows, and the policies configured in each, appear.
5. (Optional) Click the View Policy icon to view details about any policy in the flow.
   The View Policy dialog appears, displaying the configuration of and comments describing this policy. You can’t make any changes on this dialog.

Deploying or Redeploying an API Endpoint to a Gateway

You can deploy or redeploy an API to a gateway to which you have deployment privileges.To deploy or redeploy an API, Gateway Managers be issued the Manage Gateway or Deploy to Gateway grant for the gateway they want to deploy to and the Deploy API grant for the API they want to deploy.

To deploy or redeploy an API:

1. From the Gateways List page, click the gateway you want to deploy or redeploy an API to.
2. Click the (Deployments) tab.
3. To deploy an API that is not already deployed to the gateway:
   1. Click Deploy API.
   2. Use the Filter field to find the API that you want to deploy, and then select the API.
   3. From the Initial Deployment State section, select Active to deploy the API in an active state, or select Inactive to deploy the API in an inactive state.
   4. (Optional) In the Description field, enter comments about the API deployment.
   5. Click Deploy.
   The deployment enters a Waiting state and the logical gateway definition is updated. The endpoint is deployed the next time gateway node(s) poll the management server for the updated gateway definition.
4. To redeploy an API that is already deployed to a gateway:
   1. Hover over the Production Gateway deployment, and click Redeploy when it appears.
   2. Click Latest Iteration to deploy the most recently saved iteration of the API, or click Current Iteration to redeploy the currently deployed iteration of the API.
      
      
      Description of the illustration redeploy-api-iteration.png
      
   3. When prompted, enter comments about why you are redeploying the API, and then click Yes.
   The deployment enters a Waiting state and the logical gateway definition is updated. The endpoint is deployed the next time gateway node(s) poll the management server for the updated gateway definition.

Approving an API Deployment Request

Gateway Managers approve API Deployment requests.

API Managers issued the Request Deployment to Gateway grant can request API deployments to a gateway. These APIs are placed in a Requesting state. APIs in this state do not process requests until the deployment is approved.

Gateway Managers must be issued the Manage Gateway grant to approve API deployment requests for a gateway.

To approve an API deployment request:

1. From the Gateways List page, click the gateway you want to approve deployment requests for.
2. Click the (Deployments) tab.
3. Click the Requesting tab.
4. Hover over the API you want to approve and click Approve.

   Note:

   You can also click Reject to reject the request or Cancel to dismiss the request.

The deployment is approved and enters the Waiting state. The API is deployed to nodes registered to the gateway when each polls the management service for the latest logical gateway definition.

Undeploying an API

Undeploy an API if you no longer want gateway nodes to process requests for it. Gateway Managers must be issued the Manage Gateway grant or the Deploy API (API) and Deploy to Gateway (gateway) grants to undeploy an API from a gateway.

To undeploy an API:

1. From the Gateways List page, click the gateway you want to undeploy APIs from.
2. Click the (Deployments) tab.
3. Hover over the API you want to undeploy, and click Undeploy.
4. When prompted, enter comments about why you are redeploying the API, and then click Yes.

The undeployment request enters the Waiting state, which means that the undeployment request is pending. The API is undeployed from nodes registered to the gateway when each polls the management service for the latest logical gateway definition.