Deploy an API instance

Perform the following steps to deploy an API instance:

  1. Navigate to Security > API Gateway > Deployments.

  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.

      Alternatively, you can select an IPAM network to allocate the IP address. To view the allocated IP address from the IPAM network, navigate to Settings > IPAM. For more information on IPAM, see Configure IPAM.

  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.

Enable the API analytics

The following are the prerequisites to enable analytics for a deployment:

  • Ensure that virtual servers are licensed

  • Ensure that analytics status is Disabled

  • Ensure that virtual servers are in UP status

To enable the API analytics for a deployment, do the following:

  1. Select the deployment to which you want to enable the API analytics.

  2. Click Enable Analytics.

    Enable analytics for an API deployment

  3. In the Configure Analytics for deployment page, select the virtual server, and click Enable Analytics.

    Configure analytics for an API deployment

  4. On the Enable Analytics window:

    1. Select the insight type (Web Insight, Security Insight, Bot Insight)

    2. Select Logstream or IPFIX as Transport Mode.

      For more information about IPFIX and Logstream, see Logstream overview.

    3. The Expression is true by default.

    4. Click OK.

    Enable the API analytics

The Citrix ADM processes to enable analytics on the selected virtual servers.

Deploy an API instance