AGILITY API Endpoints
Services
Get service list
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
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'
Analysis
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
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'
Get 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
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'
Get all analyses
Endpoint
GET /cv/api/v1/analysis
Return all analyses based on the filter criteria
Parameters
datetimeFrom
: (Optional) Look for analyses created after the given datetime (UTC)
Format: YYYY-MM-DDTHH:MM:SS.datetimeTo
: (Optional) Look for analyses created before the given datetime (UTC)
Format: YYYY-MM-DDTHH:MM:SScontainsInFilePath
: (Optional) Specify a given string in the file path.finalStatus
: (Optional) Comma separated list of values of final status:SUCCESS: true
FAILURE: false
WARNING: warning
PENDING: pending
TIMEOUT: timeout
results
: (Optional) Look for analyses where at least one its call flow predictions matches the given results. This should be passed as a comma separated list of values:SUCCESS: success
FAILURE: failure
WARNING: warning
UNKNOWN: unknown
orderAsc
: (Optional) Sort the results by created date in ascending order (Default: false).page
: (Optional) Specify the page number. (Default: 1).size
: (Optional) Specify the number of results per page. (Default: 50; Maximum: 100).
Example request
Get analysis file
Endpoint
GET /cv/api/v1/analysis/{analysis_id}/file
Return the original file that was used for the analysis.
Parameters
analysis_id
: The ID of the analysis (received from the previous step).
Example request
Webhooks
Webhooks allow you to monitor events on your AGILITY account, enabling your integrations to automatically trigger reactions. Click here for more information.
Register webhooks
Webhook registration endpoint.
Endpoint
POST /cv/api/v1/webhooks
Request body
url
: The URL of your webhook endpoint.events
: A list of events you want to subscribe to. Use["*"]
to subscribe to all events.description
: (Optional): A brief description of your webhook.enabled
: (Optional): Set totrue
to enable the webhook immediately.subscribe_to_all_users
: (Optional): Set totrue
to subscribe all users to events.
Example request
Get all subscriptions
Return all webhook subscriptions based on filter criteria.
Endpoint
GET /cv/api/v1/webhooks
Parameters
listAll
: (Optional) (Default: false)filterEnabled
: (Optional) (Default: false)orderAsc
: (Optional) Sort the results by created date in ascending order (Default: false).page
: (Optional) Specify the page number. (Default: 1).size
: (Optional) Specify the number of results per page. (Default: 50; Maximum: 100).
Example request
Get subscription by ID
Get webhook subscription by id
Endpoint
GET/cv/api/v1/webhooks
/{subscription_id}
Parameters
subscription_id
:
Example request
Update subscription
Update webhook subscription.
Endpoint
PUT /cv/api/v1/webhooks/{subscription_id}
Parameters
subscription_id
:
Example request
Delete subscription
Delete webhook subscription
Endpoint
DELETE/cv/api/v1/webhooks/{subscription_id}
Parameters
subscription_id
:
Example request
Roll secret subscription
Roll signing secrets
Endpoint
PUT /cv/api/v1/webhooks/{subscription_id}/roll-secret
Parameters
subscription_id
:
Example request
Check subscription URL
Test webhook URL access.
Endpoint
POST /cv/api/v1/webhooks/{subscription_id}/
test
Parameters
subscription_id
:
Example request
Get webhook failure log
Get failures logs for a given webhook subscription.
Endpoint
GET/cv/api/v1/webhooks/{subscription_id}/failures
Parameters
subscription_id
:page
: (Optional) Specify the page number. (Default: 1).size
: (Optional) Specify the number of results per page. (Default: 50; Maximum: 100).
Example request
Network Topology
The Network Topology API provides a structured way to access details about the connections between network elements within your environment. It captures information about the source and destination network topology, IPs, Ports, the protocols in use, and the specific interfaces facilitating these connections.
API Endpoint
Endpoint: /api/v1/network/topology
Method: GET
Parameters
analysis_id
(path parameter): The unique identifier for the analysis. This is a required parameter.Type:
string
Description: The unique identifier of the network topology analysis to retrieve.
callflowKey
(query parameter): An optional parameter to filter the results based on a specific call flow key.Type:
string
Description: A key used to filter the network topology information by a particular call flow.