Getting Started

Base URL

Every API request will begin with the following base URL.

https://<Cisco Cyber Vision Center IP address>/api/3.0/

What are Cisco Cyber Vision APIs used for?

Cisco Cyber Vision RESTful APIs enable you to track and vizualise data trends and network security performance. The set includes APIs related to the following:

  • Active Discovery: Create, run, and manage active discovery profiles and policies.
  • Activities: Aggregate and view data flows between components.
  • Baselines: Create and manage snapshots of the network in monitor mode.
  • Baseline Differences: Compare and review differences between actual network activity and baseline descriptions in monitor mode.
  • Components: Get components lists and details such as credentials, vulnerabilities, flows, tags, and variables. You can also add or patch components.
  • Custom Network: Create, view, and manage custom networks.
  • Custom Properties: Manage custom properties that can be added to components or groups.
  • Dashboard: View and manage dashboard information.
  • Deployments: View information about your network deployments.
  • Devices: Get lists of devices and various device data such as activities, activity tags, risk scores, vulnerabilities, credentials, and variables. You can also add and view network node lists.
  • External Communication: Get details of a component's external communications.
  • Flows: View the details of network interactions between components. View and update preset flow lists.
  • Global Credentials: Create, view, and manage global credentials.
  • Graph: Get a graphical representation of the components, activities, and more for a preset.
  • Groups: Create and manage component groups.
  • Parameters: Access and manage default and custom application parameters.
  • PCAP Replays: Manage information about PCAP replays.
  • Presets: Access and manage presets to filter and visualize data as required.
  • Reports: Manage preset-based reports.
  • RiskScores: Access and manage risk score configurations.
  • Sensor Explorer: View and manage lists of the sensors in your network.
  • Sensors: Access and manage information about enrolled sensors.
  • Tags: View and manage tags.
  • Vulnerabilities: View and manage vulnerability lists.

Try Out Cisco Cyber Vision APIs

You can test Cisco Cyber Vision API request payloads in the center. An API token is required to authorize the testing of APIs. If you do not have an API token, see the Authentication section for guidance. You need to authorize API testing each time you navigate to the API Documentation page.

To start testing API request payloads, log in to your Cisco Cyber Vision center and carry out the following steps.

  1. From the main menu, choose Admin > API > Documentation.
  2. Click Authorize.
  3. Enter the API token that you created in the Admin > API > Token page.
  4. Click Close.
  5. Click the API that you want to test.
  6. Click Try it out.
  7. Edit the parameter values.
  8. Click Execute.

Download the Cisco Cyber Vision API JSON file

From the main menu, choose Admin > API > Documentation. Choose cisco-cyber-vision-api-v3.json and the JSON file opens in a new tab. You can download the file to your local system to start using the API.