Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


This page guides you through the usage of the AGILITY API to help you get started integrating and using the AGILITY API to analyze network traces.


Please ensure that you have the necessary credentials and permissions to access the API (login ID and password) from your administrator.

Note: when using the Community version of AGILITY, you will need to create an account using your email address instead of through your LinkedIn or Google account.


The AGILITY API is designed for system integrators and developers to enable advanced analysis on network traces, specializing in root cause analysis for call flows. The API supports file formats such as .PCAP, .PCAPNG, .CAP, and .ZIP.

API base URL

Use the base URL to access the OpenAPI documentation:


(example: ).


Use the OAuth2 Password Flow to request an id_token.

Request the token


POST /cv/auth/realms/agility/protocol/openid-connect/token

Provide your username, password, and the client_id (which is public and provided as d0d8b0d806f9) in your request.


  • Content-Type: application/x-www-form-urlencoded


  • grant_type: password

  • client_id: d0d8b0d806f9

  • username: Your registered user name.

  • password: Your password.

  • scope: openid

Example cURL request

Code Block
curl -X POST \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "grant_type=password&client_id=d0d8b0d806f9&username=YOUR_USERNAME&password=YOUR_PASSWORD&scope=openid"

Replace YOUR_USERNAME and YOUR_PASSWORD with your credentials.


Upon successful authentication, you'll receive a JSON response containing the id_token among other tokens.



Note: Always keep your id_token, access_token, and refresh_token secure. Do not expose them in client-side scripts or other insecure locations.

Handling expired tokens

When an access token expires, AGILITY API will no longer accept incoming request and will redirect you to the login page. We recommend that you request a new id_token using the refresh token request if it still valid or just re-authenticate.