AGILITY API Endpoints

https://agility-community.b-yond.com/cv/api/public/docs#/

Services

Retrieve 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:SS

  • containsInFilePath: (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

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'

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

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'

 

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 to true to enable the webhook immediately.

  • subscribe_to_all_users: (Optional): Set to true to subscribe all users to events.

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 }'

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