Sysdig Monitor/Secure Python client library
Clone or download
philrz Merge pull request #62 from draios/dashboard-restore-skip-non-json
Catch exception for non-JSON items in Dashboard ZIP
Latest commit fb2efb5 Aug 13, 2018

README.md

Sysdig Monitor/Secure Python client library

Build Status Current version on PyPI

A Python client API for Sysdig Monitor/Sysdig Secure.

This module is a wrapper around the Sysdig Monitor/Sysdig Secure APIs, which are documented here. It exposes most of the sysdig REST API functionality as an easy to use and easy to install Python interface. The repository includes a rich set of examples (in the examples subdir) that quickly address several use cases.

Installation

Automatic w/ PyPI (virtualenv is recommended.)

pip install sdcclient

Manual

git clone https://github.com/draios/python-sdc-client.git
cd python-sdc-client
python setup.py install

One-step cmdline to create virtualenv, install client, and gain access to sample programs

$ virtualenv python-sdc-env && source python-sdc-env/bin/activate && pip install sdcclient && git clone https://github.com/draios/python-sdc-client && python python-sdc-client/examples/set_secure_system_falco_rules.py --help

Quick start

Usage

Note: in order to use this API you must obtain a Sysdig Monitor/Secure API token. You can get your user's token in the Sysdig Monitor API section of the settings page for monitor or secure.

The library exports two classes, SdMonitorClient and SdSecureClient that are used to connect to Sysdig Monitor/Secure and execute actions. They can be instantiated like this:

from sdcclient import SdMonitorClient

api_token = "MY_API_TOKEN"

#
# Instantiate the Sysdig Monitor client
#
client = SdMonitorClient(api_token)

For backwards compatibility purposes, a third class SdcClient is exported which is an alias of SdMonitorClient.

Once instantiated, all the methods documented below can be called on the object.

Return Values

Every method in the SdMonitorClient/SdSecureClient classes returns a list with two entries. The first one is a boolean value indicating if the call was successful. The second entry depends on the result:

  • If the call was successful, it's a dictionary reflecting the json returned by the underlying REST call
  • If the call failed, it's a string describing the error

For an example on how to parse this output, take a look at a simple example like get_data_simple.py

Function List & Documentation

For the list of available functions in the current master branch of this repo and corresponding docs, refer to the Python Script Library documentation page. Equivalent docs for the functions in the most recent "stable" release (which is what you'd get via pip install, and corresponds to the most recent release) are located here.

On-Premises Installs

For On-Premises Sysdig Monitor installs, additional configuration is necessary to point to your API server rather than the default SaaS-based one, and also to easily connect when using a self-signed certificate for SSL. One way to handle this is by setting environment variables before running your Python scripts:

export SDC_URL='https://<YOUR-API-SERVER-HOSTNAME-OR-IP>'
export SDC_SSL_VERIFY='false'

Alternatively, you can specify the additional arguments in your Python scripts as you instantiate the SDC client:

client = SdMonitorClient(api_token, sdc_url='https://<YOUR-API-SERVER-HOSTNAME-OR-IP>', ssl_verify=False)

Transitioning from Python to REST

If your goal is to interact with the REST API directly, you can use this Python client library to understand the REST interactions by logging the actions it takes. This is useful because full documentation of the REST API has not yet been created; and also provides a complete example of known working operations.

  • Use or modify an example, or write a new script against the Python sdcclient module.
  • Log the HTTP requests made by the script.

To log all the requests made by your script in significant detail, add to your script:

import logging
import httplib
httplib.HTTPConnection.debuglevel = 1

logging.basicConfig() # you need to initialize logging, otherwise you will not see anything from requests
logging.getLogger().setLevel(logging.DEBUG)
requests_log = logging.getLogger("requests.packages.urllib3")
requests_log.setLevel(logging.DEBUG)
requests_log.propagate = True

Then run as normal.