CyberWatch Api Tools.
Project description
Cyberwatch API toolbox
A simple interface for your Cyberwatch instance API.
Installation
Prerequisites
Install the latest package
To install Cyberwatch API toolbox, simply use python 3 with:
$ pip3 install cbw-api-toolbox
Install an older package version
Some scripts from version 1.X may not work in version 2.X of cbw-api-toolbox
, to install an older version, simply do:
pip3 install cbw-api-toolbox==1.1.2
Test your installation
Create a new file called ping.py
and copy/paste this content
# ping.py
import os
from configparser import ConfigParser
from cbw_api_toolbox.cbw_api import CBWApi
CONF = ConfigParser()
CONF.read(os.path.join(os.path.abspath(os.path.dirname(__file__)), '..', 'api.conf'))
CLIENT = CBWApi(CONF.get('cyberwatch', 'url'), CONF.get('cyberwatch', 'api_key'), CONF.get('cyberwatch', 'secret_key'))
CLIENT.ping()
Configure an api.conf file with your credentials
See the Configuration section
Test your script
$ python3 ping.py
If everything is ok, the OK
message will appear
$ python3 ping.py
INFO:root:OK
Otherwise, the FAILED
message will appear
$ python3 ping.py
ERROR:root:FAILED
In this case, please check that there are no typing errors in your API_KEY
, SECRET_KEY
or API_URL
and that your Cyberwatch instance is up.
Configuration
Create an api.conf
file at the root of the project (see example_api.conf
)
api_key
: your Cyberwatch user api keyapi_key
: your Cyberwatch user secret keyurl
: your Cyberwatch instance URL
Example
[cyberwatch]
api_key = PyXpxrcJ7rQ...
secret_key = +bUx37WnB0qt...
url = https://myinstance.local
To find your API credentials:
- Click on your profile page in your cyberwatch instance web page
- Click on the button 'see my api keys'
Usage
Launch a script example
- Choose a script from the examples directory and copy it to your computer
- Edit the script with your API credentials (See Configuration)
- Launch the script
$ python3 your_example_script_file.py
API Documentation
See the full API documentation here
Library Documentation
See the library-specific documentation here
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cbw_api_toolbox-2.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c769cd8783bad11bc34458988864c01c1b382b3e3e37a82783d45e4be59ef9f6 |
|
MD5 | b60127f018346b0e8f04a7806158242c |
|
BLAKE2b-256 | 459c3f80308a55a023913df9acd3e9dadd6f5848c628262879bab3b503b22d79 |