Cyberwatch Cyberwatch

Integrate Cyberwatch to retrieve vulnerability management data

The Cyberwatch connector allows you to retrieve asset inventory and vulnerability data detected by your Cyberwatch platform directly into OverView.

Objective

The Cyberwatch connector retrieves the following information:

  • Asset inventory (servers, workstations, network equipment)
  • Detected vulnerabilities with CVE references
  • Compliance score and remediation priorities

Prerequisites

  • Access to your Cyberwatch instance
  • Administrator permissions to access inventory data
  • Ability to generate API keys

Information to provide in OverView

FieldDescription
API URLBase URL of your Cyberwatch instance (e.g., https://cyberwatch.example.com)
API KeyAPI key for authentication
API SecretAPI secret for authentication

Parameters

These parameters are optional. Leave them at their default value unless you have a specific reason to change them.

ParameterDescriptionDefault
Verify SSLVerify SSL certificate when connecting to the APIDisabled

Procedure

Generate API Credentials in Cyberwatch

  1. Sign in to your Cyberwatch instance.
  2. Go to Profile > API Keys.
  3. Click "View my API keys" or "+ Add" to create a new key.
  4. Generate the API credentials:
    • API Access Key ID: Auto-generated identifier.
    • API Secret Access Key: Auto-generated secret.
  5. Optionally, export the credentials as an api.conf file for reference.
  6. Copy both the API Access Key ID and API Secret Access Key immediately.
  7. For OverView, ensure the API key has "Read only" access level.

Retrieve the API URL

  1. The API URL is the base URL of your Cyberwatch instance.
  2. Example: https://cyberwatch.example.com or https://app.cyberwatch.io for the SaaS version.

Configure the Connector in OverView

  1. In OverView, go to Data Sources Settings > Sources.
  2. Select Cyberwatch and click Configure.
  3. Fill in the three required fields:
    • API URL: Base URL of your Cyberwatch instance.
    • API Key: Your API Access Key ID.
    • API Secret: Your API Secret Access Key.
  4. Click Save Configuration.
Alternative: file import through DropPoint

The API access described above is the recommended method for this connector. Where it is not available (a segregated network, a version or licence without API, an export you already produce), OverView accepts file exports, to be uploaded to the bucket dedicated to Cyberwatch.

Where do the files go?

Bucket : s3://cyberwatch/

Example : s3://cyberwatch/export.csv

The procedure is described in the OverView DropPoint guide: generating credentials, configuring the client, then sending files from the OverView web interface, the AWS CLI or an SDK. Its examples come pre-filled with this bucket when you follow this link.

Official Documentation

For additional information, refer to the Cyberwatch API documentation.

Required Permissions

The API credentials must have the following permissions:

  • Read access to asset inventory
  • Read access to vulnerabilities and detections
  • Read access to compliance reports