...

Services

Get service list

Endpoint

GET /cv/api/v1/services

...

Use this endpoint to fetch a list of supported services.

...

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'

...

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'

...

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'

...

Example request

curl -X 'GET' \
  'https://cv-dev.b-yond.com/cv/api/v1/analysis?datetimeFrom=2023-10-01T00%3A00%3A00&datetimeTo=2023-10-31T23%3A59%3A59&containsInFilePath=pcap&finalStatus=true%2Cfalse%2Cwarning&results=success%2Cfailure%2Cwarning&orderAsc=false&page=1&size=50' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_ID_TOKEN'

...

Example request

curl -X 'GET' \
  'https://cv-dev.b-yond.com/cv/api/v1/analysis/d8116c50-c891-4378-9191-5b8bb53d873b/file' \
  -H 'accept: application/octet-stream' \
  -H 'Authorization: Bearer YOUR_ID_TOKEN'

...

Example request

curl -X 'POST' \
  'https://agility.b-yond.com/cv/api/v1/webhooks/subscriptions' \
  -H 'accept: application/json' \
  -H 'userId: 1234' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com/",
  "events": [
    "*"
  ],
  "description": "My webhook",
  "enabled": true,
  "subscribe_to_all_users": true
}'

...

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 elementstopology, IPs, Ports, the protocols in use, and the specific interfaces facilitating these connections.

...

• 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.

Intent-Based Diagnostics Endpoints

The Intent-Based Diagnostics feature in AGILITY allows users to perform detailed network diagnostics through various pre-configured scenarios. It enables the evaluation of variety of scenarios defined by 3GPP and ETSI while allowing users to bring their own scenarios

Find Available Scenarios

Endpoint

GET /v1/intent-based-diagnostic/evaluation-scenarios

Description

This endpoint lists all evaluation scenarios, including system scenarios (pre-built by AGILITY) and extended scenarios (user-created by modifying system scenarios).

Parameters

• name: Filter by scenario name (partial match).

• category: Filter by scenario category.

• scenarioType: Filter by type (SYSTEM or EXTENDED). A System Scenario is provided out of the box and cannot be modified. An Extended Scenario is created by users by extending a System Scenario and overriding its parameters.

• createdByCurrentUser: Filter scenarios created by the current user.

• editedByCurrentUser: Filter scenarios last edited by the current user.

• lastModifiedDateFrom: Filter scenarios modified on or after a specific date.

• lastModifiedDateTo: Filter scenarios modified on or before a specific date.

• customTestCaseId: Filter scenarios by custom test case ID. It is used to link a given input file automatically to a scenario when using the autoloader. 

• page: Page number (default: 1).

• size: Page size (default: 50).

Example Request

curl -X 'GET' \
  'https://agility-dev.b-yond.com/cv/api/v1/intent-based-diagnostic/evaluation-scenarios?formatSteps=false&page=1&size=50' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_ID_TOKEN' \
  -H 'userId: user123'

Submit a New Evaluation

Endpoint:

POST /v1/intent-based-diagnostic/evaluations/file

Description

This endpoint submits a network trace file for evaluation against a specific scenario.

Request Body

• Headers:

  • userId (required): The ID of the user submitting the request.

• Payload:

  • uploadFile: The trace file (.PCAP, .PCAPNG, .CAP, or .ZIP).

  • scenarioId (required): The ID of the scenario to evaluate.

  • parameterValuesOverride (optional): Custom parameters to override scenario defaults.

Example Request

curl -X 'POST' \
  'https://agility-dev.b-yond.com/cv/api/v1/intent-based-diagnostic/evaluations/file' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_ID_TOKEN' \
  -H 'userId: user123' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@example_trace.pcapng' \
  -F 'scenarioId=69'

Check Evaluation Status and Retrieve Results

Endpoint:

GET /v1/intent-based-diagnostic/evaluations/{id}

Description

Retrieve the status and results of an evaluation by its ID.

Path Parameters

• id (required): The evaluation ID returned from the POST /evaluations/file endpoint.

Query Parameters

• multicallflowSupport: If true, segregates results by callflow sets.

Statuses

• pending: The evaluation is queued.

• processing: The evaluation is in progress.

• completed: The evaluation has finished, and results are available.

Example Request

curl -X 'GET' \
  'https://agility-dev.b-yond.com/cv/api/v1/intent-based-diagnostic/evaluations/783e4a2c-9875-4f31-ac82-a1ffe1b11a34?multicallflowSupport=true' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_ID_TOKEN' \
  -H 'userId: user123'

Search Evaluations

Endpoint

GET /v1/intent-based-diagnostic/evaluations

Description

Return all Intent Based Evaluations based on filter criteria.

Parameters

Headers:

• userId (required): The username of the user making the request.

Query Parameters:

• datetimeRanges: Filter by predefined datetime ranges.

• datetimeFrom: Filter evaluations created after this datetime.

• datetimeTo: Filter evaluations created before this datetime.

• containsInFilename: Filter by filename containing this string.

• evaluationStatus: Filter by evaluation status.

• scenarioIds: Filter by scenario IDs.

• createdOnAsc: Sort by creation date in ascending order (default: false).

• listAll: List all evaluations (default: false).

• multicallflowSupport: Enable multicallflow support.

• page: Page number (default: 1).

• size: Page size (default: 50, max: 100).

Example Request

curl -X 'GET' \
  'https://agility-dev.b-yond.com/cv/api/v1/intent-based-diagnostic/evaluations?createdOnAsc=false&listAll=true&page=1&size=50' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_ID_TOKEN' \
  -H 'userId: user123'