Skip to main content

Python bindings for Cylance Console

Project description


This Library provides python bindings to interact with the Cylance API. Examples have been created for you in the Examples/ directory, and provide a majority of the common code you'll need to get setup. In order to utilize this Library, you will need an API token from the API Integrations tab inside of the Cylance Console.

Supported Systems

  • Python 2.7 & Python 3 Compatible
  • Windows
  • Mac


pip install cyapi


This example will create a connection to the API and return all devices that have registered.

from cyapi.cyapi import CyAPI
from pprint import pprint
API = CyAPI(tid=your_id, aid=your_aid, ase=your_ase)
devices = API.get_devices()
print("Successful: {}".format(devices.is_success))
pprint([0]) # Print info about a single device.

If you have lots of devices/threats/zones/etc, and you'd like to see a progress bar, pass the disable_progress parameter:

devices = API.get_devices(disable_progress=False)

Additionally you can copy examples/ to and begin hacking away from there.

Creds File

You can create a file that will store your api credentials instead of passing them in via the command line. The creds file should look like the following:


    "tid": "123456-55555-66666-888888888",
    "app_id": "11111111-222222-33333-44444444",
    "app_secret": "555555-666666-222222-444444",
    "region": "NA"

This file can then be passed in by passing -c path/to/creds.json to any of the examples


See [][]

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cyapi, version 0.9.17
Filename, size File type Python version Upload date Hashes
Filename, size cyapi-0.9.17-py2.py3-none-any.whl (25.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size cyapi-0.9.17.tar.gz (18.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page