kentik-api 0.3.1

SDK library for Kentik API

Kentik API python library.

This is a python wrapper for kentik rest api.
For more information on how to interact with kentik resources using this library, see examples in examples/ folder.

Installation with pip

1. Install the library using pip:
   pip3 install kentik-api
2. Check installation successful - no errors should be reported:
   python3 -c "import kentik_api"
3. Run an example (optional):

export KTAPI_AUTH_EMAIL=<your kentik api credentials email>
export KTAPI_AUTH_TOKEN=<your kentik api credentials token>
python3 examples/sites_example.py

Getting started

The example below illustrates how to create a new device using the library:

# library-specific imports
from kentik_api import (
    KentikAPI,
    Device,
    DeviceSubtype,
    CDNAttribute,
    ID,
)

# initialize Kentik API client
api_client = KentikAPI("<API_EMAIL_STRING>", "<API_TOKEN_STRING>")

# prepare device object
device = Device.new_dns(
    device_name="example-device-1",
    device_subtype=DeviceSubtype.aws_subnet,
    cdn_attr=CDNAttribute.yes,
    device_sample_rate=100,
    plan_id=ID(11466),
    site_id=ID(8483),
    device_bgp_flowspec=True,
)

# create the device
created = api_client.devices.create(device)

# print returned device's attributes
print(created.__dict__)

As you can see, one can create a device using KentikAPI.devices interface.
Interfaces for manipulating all KentikAPI resources are available under KentikAPI object.
The general approach is that every single KentikAPI resource is represented in the library by a public class, and all the types/enums/constants related to given resource are collected together with the resource class (in the same source file):

• CustomApplication
• CustomDimension
• DeviceLabel
• Device
• ManualMitigation
• Plan
• QueryObject
• QuerySQL
• SavedFilter
• Site
• Tag
• Tenant
• User

Additional utilities available in the utils sub-module

Authentication support

• get_credentials: function for retrieving authentication credentials from the environment or a profile stored on disk. API authentication credentials can be provided via environment variables KTAPI_AUTH_EMAIL and KTAPI_AUTH_TOKEN or via named profile (specified as argument to the get_credentials functions, defaulting to default) which is a JSON file with following format:

{
  "email": "<email address>",
  "api-key": "<the API key>"
}

Path to the profile file can be provided in KTAPI_CFG_FILE. Otherwise it is first searched in ${KTAPI_HOME}/<profile_name> and then in ${HOME}/.kentik/<profile_name>.

Support for caching of device data

The DeviceCache class allows caching of device related data obtained from the Kentik API. It internally builds index of devices by name and by id. Devices are represented by the Device class which internally builds dictionary of device interfaces (represented by the DeviceInterface class) by name.

Analytic support

The analytics package provides support for processing Kentik time series data using Pandas Dataframes. The pandas and PyYAML modules are required by the analytics sub-module and are automatically installed with the kentik-api[analytics] option. See analytics readme for more details.

More examples

List of available examples:

• alerting_example.py - create Manual Mitigation
• applications_example.py - create/update/delete Custom Application
• bulk_user_create.py - create users from YAML file
• devices_example.py - create/update/get/delete/list Devices
• dimensions_example.py - create/update/get/delete/list Custom Dimensions, create/update/delete Populator
• labels_example.py - create/update/get/delete/list Device Labels
• my_kentik_portal_example.py - get/list Tenants, create/delete Tenant User
• plans_example.py - list plans
• queries_example.py - query for SQL/URL/data/chart
• saved_filters_example.py - create/update/get/delete/list Saved Filters
• sites_example.py - create/update/get/delete/list Sites
• tags_example.py - create/update/get/delete/list Tags
• users_example.py - create/update/get/delete/list Users
• error_handling_example.py - handling errors raised by the library
• analytics_example_sql.py - use of SQLQueryDefinition, flatness_analysis method and theDeviceCache
• analytics_example_topx.py - use of DataQueryDefinition, flatness_analysis method and theDeviceCache (see also analytics readme)

Open-source libraries

This software uses the following open-source libraries:

• dacite by Konrad Hałas - MIT License
• requests by Kenneth Reitz - Apache Software License (Apache 2.0)
• typing-extensions by Guido van Rossum, Jukka Lehtosalo, Lukasz Langa, Michael Lee - PSFL License
• pandas supported by NumFOCUS - BSD 3-Clause License
• pyyaml by Ingy döt Net and Kirill Simonov - MIT license