ADC

API traffic visibility using API specification validation

April 15, 2024

Contributed by:

NetScaler provides an option to export additional information as part of the HTTP transactions related to the HTTP APIs when it determines the traffic as API traffic.

For more information on exporting the HTTP transaction logs, see Export transaction logs directly from NetScaler to Splunk.

Enable API traffic visibility with the API specification using the CLI

Create the API profile

At the command prompt, type:

add api profile <name>
Enable the API visibility

At the command prompt, type

set api profile <name> -apiVisibility <ENABLED/DISABLED>
Bind the specification to the profile

At the command prompt, type:

bind -apiprofile <name> -apiSpec <name>
Assign the profile to a virtual server At the command prompt, type: set cs vserver <name> -apiprofile <name>

Example:

add api profile test_apiprofile1
set api profile test_apiprofile1 -apiVisibility enabled
bind api profile test_apiprofile1 -apispec testapi spec name
set cs verser vserver_test1 -apiprofile test_apiprofile1
<!--NeedCopy-->

If the incoming traffic matches the endpoint in the API specification, then apiEndpoint, apiSpecName, and isApi parameters are sent in the HTTP transaction logs.

Enable API traffic visibility without the API Specification using the CLI

Create the API profile

At the command prompt, type:

add api profile <name>
Enable the API visibility

At the command prompt, type:

set api profile <name> -apiVisibility <ENABLED/DISABLED>
Assign the profile to virtual server

At the command prompt, type:

set cs vserver <name> -apiprofile <name>

Example:

add api profile test_apiprofile
set api profile <test_apiprofile> -apiVisibility enabled
set cs verser vserver_test -apiprofile test_apiprofile
<!--NeedCopy-->

If the incoming traffic is API traffic, then isApi parameter is sent in the HTTP transaction logs.

Enable API traffic visibility using GUI

Navigate to System > Profiles > API Profiles.
Click Add.
On the API Profiles page, enter a Name for the API profile.
Select API Visibility, and click OK.
To enable API traffic visibility, bind the API Specification file.
1. On the API Profiles page, under Advanced Settings, click API Spec.
2. In the API SPEC Binding section, click > and select the required API specification.
3. Click Bind and then click Close.
Click Done.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group 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 Cloud Software Group 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 Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

API traffic visibility using API specification validation

April 15, 2024

Contributed by:

April 15, 2024

Contributed by:

API traffic visibility using API specification validation

Enable API traffic visibility with the API specification using the CLI

Enable API traffic visibility without the API Specification using the CLI

Enable API traffic visibility using GUI

In this article