kairosdb.client – KairosDB REST API client

class kairosdb.client.KairosDBAPIClient(api_endpoint, verify=None, timeout=None)

KairosDB API client

It implements common HTTP methods GET, POST, PUT and DELETE This client is using requests package. Please see http://docs.python-requests.org/ for more information.

Parameters:

• verify (bool) – Control SSL certificate validation
• timeout (int) – Request timeout in seconds
• api_endpoint (str) – KairosDB API endpoint

get(self, path, data=None, **kwargs)

Partial method invoking request() with http method GET.

post(self, path, data=None, **kwargs)

Partial method invoking request() with http method POST.

put(self, path, data=None, **kwargs)

Partial method invoking request() with http method PUT.

delete(self, path, data=None, **kwargs)

Partial method invoking request() with http method DELETE.

request(path, method, data=None, **kwargs)

Handle requests to API

Parameters:

• path (str) – API endpoint’s path to request
• method (str) – HTTP method to use
• data (dict) – Data to send (optional)

Returns:

Parsed json response as dict

Additional named argument may be passed and are directly transmitted to request() method of requests.Session object.

class kairosdb.client.KairosDBAPIEndPoint(api_client)

KairosDB API endpoint

This class do not provide convenience methods get(), post(), put() and delete(). Those methods should be implemented by subclasses.

Parameters:api_client (CachetAPIClient) – Cachet API client instance

api_client

CachetAPIClient instance passed at instantiation.

_get

Alias to get() method of api_client instance.

_post

Alias to post() method of api_client instance.

_put

Alias to put() method of api_client instance.

_delete

Alias to delete() method of api_client instance.