Deploy an API definition

December 3, 2020

Contributed by:

Perform the following steps to deploy an API definition:

Navigate to Applications > API Gateway > Deployment.
Click Add.
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
  Note
  
  Upload TLS Certificate and Key in a PEM format.
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.
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.
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:

Select the deployment to which you want to enable the API analytics.
Click Enable Analytics.
In the Configure Analytics for deployment page, select the virtual server, and click Enable Analytics.
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.

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

The official version of this content is in English. Some of the Citrix documentation content is machine translated for your convenience only. Citrix has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Citrix product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Citrix, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Citrix will not be held responsible for any damage or issues that may arise from using machine-translated content.

Deploy an API definition

December 3, 2020

Contributed by:

December 3, 2020

Contributed by:

Deploy an API definition

Enable the API analytics

In this article