cyberwatch-api 0.3.10

Python Api client for the Cyberwatch software

Cyberwatch API

Python Api client for the Cyberwatch software

Table of Contents

• Installation
  • Prerequisites
  • Module installation
  • Configuration
  • api.conf file location
• Ping
• Examples
• Usage
• Command Line Documentation
• FAQs

Installation

Prerequisites

• Python 3
• Python PIP

Module installation

To install the Cyberwatch API module, use Python 3 with:

pip3 install cyberwatch_api

[!WARNING] Since pip 23.1, using pip in the system is disabled by defaut to prevent breaking system packages by overwriting dependencies. To avoid this, you can use a virtual environment (python3 -m venv env), or add the --break-system-packages to force the installation. More information regarding this in the documentation.

Configuration

To be able to authenticate to the Cyberwatch API, you need to configure the api.conf file. This client authenticates using basic auth.

All the information can be retrieved in your profile on the Cyberwatch interface while creating an API user as following:

"Profile > API keys > See my API keys > +Add"

You can download directly the api.conf file after clicking on "Create > Export" or copy/paste the information to an api.conf file in this directory.

api.conf file location

The library will search for the api.conf file in the current working directory and, if there is none, in its parent directory.

If the api.conf file is located elsewhere, you can specify the path as shown below:

Cyberwatch_Pyhelper(path_to_conf="your/path/to/api.conf/file/")

Ping

Create a ping.py script with the following content inside:

from cyberwatch_api import Cyberwatch_Pyhelper

output = Cyberwatch_Pyhelper().request(
    method="get",
    endpoint="/api/v3/ping"
    )

print(next(output).json())

Then to test it, type the following command:

$ python3 ping.py

The output should look like this:

{"uuid": "1ab2c3de-546f-789g-9f87-6ed5c4b3a210"}

Otherwise, check that there are no typing errors in your API_KEY, SECRET_KEY or API_URL in the api.conf file and that your Cyberwatch instance is up.

Examples

Run an example script

1. Choose a script from the examples directory and copy it to your computer

2. Run it with the following command:

$ python3 your_example_script_file.py

Usage

Swagger documentation

Cyberwatch API provides a Swagger documentation.

Using it, you can :

• Select the action you want to perform in the documentation
• Update the "method", "endpoint" and parameters ("body_params") in you script according to the documentation
• Add any required logic

Note that the request method provided by this module always outputs a generator. This is intended to allow building of high performance scripts. If the request you perform returns a single result and not a list, you will find the result in the first row of this generator.

Location of the Swagger's documentation

You can find it while clicking on the </> logo on the top right of the Cyberwatch interface.

Request parameters

When using this API, you can use the body_params variable to send parameters to your endpoint.

output = Cyberwatch_Pyhelper().request(
    method="get",
    endpoint="/api/v3/vulnerabilities/servers/{id}",
    body_params={'id' : 7}
)

output = Cyberwatch_Pyhelper().request(
    method="put",
    endpoint="/api/v3/vulnerabilities/servers/{id}",
    body_params={'id' : 7,'description' : "this is a description", "groups":[3,4]}
)

Paginate the response

You can select how many elements are returned per-page using the per_page parameter. If you need only a single page to be returned, you may specify it using the page parameter.

output = Cyberwatch_Pyhelper().request(
    method="get",
    endpoint="/api/v3/agents",
    body_params={'per_page' : 50, 'page' : 3}
)

Command Line Documentation

See the command line interface documentation here

FAQs

What if I don't want to verify the SSL certificate?

Error example:

ssl.SSLCertVerificationError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: self-signed certificate (_ssl.c:997)

Certificate verification can be bypassed with the verify_ssl option.

For example, this option was added to the previous ping.py script as follows:

from cyberwatch_api import Cyberwatch_Pyhelper

output = Cyberwatch_Pyhelper().request(
    method="get",
    endpoint="/api/v3/ping",
    verify_ssl=False
    )

print(next(output).json())