Deploy an API

API Deploying is the process of making the API available for invocation via a Gateway. You can deploy an API to a selected API Gateway environment via the Publisher Portal. To invoke an API, it needs to be published on the Developer Portal as well as deployed on a Gateway environment. You need to create a revision of an API in order to deploy it.

Undeploying an API will remove the API from the API Gateway Environment.

Follow the steps below to deploy an API:

Step 1 - Create a new revision

  1. Sign in to the Publisher.

    https://<hostname>:9443/publisher (e.g., https://localhost:9443/publisher).

  2. Click Deployments.

  3. Click +.

    The create a new revision button

  4. Provide a description for the revision if required.

  5. Click on Create.

    Create new revision

Warning

You cannot create more than 5 revisions. If you want to create a new revision after the maximum allowed number of revisions are reached, you need to delete a previous revision.

Delete revision if max count is reached

Step 2 - Deploy the revision

  1. Sign in to the Publisher.

    https://localhost:9443/publisher

  2. Click Deployments.

  3. Click Deploy New Revision.

    Deploy a new revision

  4. Provide a description for the new revision if required.

  5. Select one or more Gateway Environments from the environments listed.
  6. Click Deploy.

    Deploy a new revision view

Top