Deploy an API definition

Perform the following steps to deploy an API definition:

  1. Navigate to Applications > API Gateway > Deployment.

  2. Click Add.

  3. In Deployment Basic Info,

    1. Specify the Deployment Name.

    2. In Target API Gateway, select an ADC instance as an API gateway.

    3. In API Definitions, select the required API definition.

    4. In API Proxy, add an API proxy to use the API Gateway. An API proxy is a front-end virtual IP address where the API Gateway receives the API traffic from clients. Specify the following details:

      • IP address

      • Port

      • TLS Security Profile – Select High or Medium from the list. If you select High, it maps to the secure SSL profile on an ADC instance.

      • TLS Certificate

      • TLS Key


      Upload TLS Certificate and Key in a PEM format.

  4. In Upstream Services, click Add to add back-end API servers where you want to transfer the API traffic. You can configure an upstream service with its domain name or IP address:

    1. Specify a name to an upstream service.

    2. Specify the domain.

    3. In Services, specify an IP address and port value. To add more IP addresses, click Add a new row.

    4. Click Add.

  5. In Routing, specify the following details to transfer API traffic based on the resource path prefix:

    1. Specify the route name.

    2. Select an API Resource to receive an API request.

    3. Select an Upstream Service from the list where you want to transfer the API traffic.

  6. Click Save to save the deployment configuration.

    If you want to deploy the configuration to API Gateway, click Save and Deploy.

Deploy an API definition