...
This page guides you through the usage of the AGILITY API to help you get started quickly.You will learn how to integrate and use integrating and using the AGILITY API to analyze network traces with ease.
Prerequisites
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.
Overview
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.
...
http(s)://<YOUR_PUBLIC_DN>/cv/api/public/docs
(example: https://cvagility-devcommunity.b-yond.com/cv/api/public/docs ).
Authentication
Use the OAuth2 Password Flow to request an id_token.
...
| Info |
|---|
Note: Remember to securely store and manage the refresh token, as it provides long-term access to the API and should be protected from unauthorized access. |
AGILITY API endpoints
Retrieve supported services
Endpoint
GET /cv/api/v1/services/
Use this endpoint to fetch a list of supported services.
Parameters
page: Specify the page number. (Default: 1)size: Specify the number of results per page. (Default: 50; Maximum: 100)
Example request
| Code Block | ||
|---|---|---|
| ||
curl -X 'GET' \
'https://cv-dev.b-yond.com/cv/api/v1/services/?page=1&size=50' \
-H 'accept: application/json' \
-H 'Authorization: Bearer YOUR_ID_TOKEN' |
Start a new analysis
Endpoint
POST /cv/api/v1/analysis/file
This endpoint allows you to initiate an analysis using a supported network trace file.
Request body
uploadFile: Upload your network trace file here (the file should be available locally).serviceKeys: (Optional) List of service keys for the analysis. If you're unsure, leave this empty for service auto-discovery.
Example request
| Code Block | ||
|---|---|---|
| ||
curl -X 'POST' \
'https://cv-dev.b-yond.com/cv/api/v1/analysis/file' \
-H 'accept: application/json' \
-H 'Authorization: Bearer YOUR_ID_TOKEN' \
-H 'Content-Type: multipart/form-data' \
-F 'uploadFile=@myfile.pcap' \
-F 'serviceKeys=volte' |
Fetch analysis results
Endpoint
GET /cv/api/v1/analysis/{analysis_id}/summary
After initiating an analysis, use this endpoint to retrieve the results.
Parameters
analysis_id: The ID of the analysis (received from the previous step).page: (Optional) Specify the page number. (Default: 1)size: (Optional) Specify the number of results per page. (Default: 50; Maximum: 1000)
Example request
...
...
➡️ Next: Use the API endpoints.