...
| 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/
...
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
...
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
| Code Block |
|---|
curl -X 'GET' \ 'https://cv-dev.b-yond.com/cv/api/v1/analysis/8599e936-19ee-4b13-a9ad-44fecadad9fe/summary?page=1&size=50' \ -H 'accept: application/json' \ -H 'Authorization: Bearer YOUR_ID_TOKEN' |
...