| Table of Contents |
|---|
This page will guide guides you through the usage of our API and help you get started quickly.
You will learn how to integrate and use the AGILITY API to analyze network traces with ease.
Prerequisites
Please ensure that you have the necessary credentials and permissions to access this API.
Overview
The AGILITY APIs are API is designed for system integrators and developers . Its primary function is to enable advanced analysis on network traces, specializing in root cause analysis for call flows within these traces. The API supports file formats such as .PCAP, .PCAPNG, .CAP, and .ZIP.
API base
...
URL
The base URL for accessing the OpenAPI documentation is: http(s)://<YOUR_PUBLIC_DN>/cv/api/public/docs (i.e https://cv-dev.b-yond.com/cv/api/public/docs )
Authentication
To interact get started with the AGILITY API, you must first authenticate to get use the OAuth2 Password Flow to request an id_token.
Here's how to do that using the OAuth2 Password Flow:
...
Request the Token
Endpoint: POST /cv/auth/realms/agility/protocol/openid-connect/token
You need to provide Provide your username, password, and the client_id (which is public and provided as d0d8b0d806f9) in your request.
...
Replace YOUR_USERNAME and YOUR_PASSWORD with your actual credentials.
Upon successful authentication, you'll receive a JSON response containing the id_token among other tokens:
...
Use the REFRESH_TOKEN_VALUE to obtain de a new token as described in the next section.
In the example above, the token expires in 300 second (5 min) while the refresh_token is valid for 1800 second (30 min).
...