Samarkand Nomad Hawk

pip install nomad-hawk==1.1.3


Nomad Hawk API

This is the API descriptor for the Nomad Hawk API, responsible for tracking and analytics.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.1.3
  • Package version: 1.1.3
  • Build package: io.swagger.codegen.languages.PythonClientCodegen


Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+

(you may need to run pip with root permission: sudo pip install git+

Then import the package:

import nomad_hawk 


Install via Setuptools.

python install --user

(or sudo python install to install the package for all users)

Then import the package:

import nomad_hawk

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import nomad_hawk
from import ApiException
from pprint import pprint

# Configure API key authorization: api_key
config = nomad_hawk.Configuration()
config.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# nomad_hawk.configuration.api_key_prefix['api_key'] = 'Bearer'
# create an instance of the API class
api_client = nomad_hawk.ApiClient(config)
api_instance = nomad_hawk.ConnectorApi()
body = nomad_hawk.Connector() # Connector | Connector definition

    # Connect a new even processor
    api_response = api_instance.connect(body)
except ApiException as e:
    print("Exception when calling ConnectorApi->connect: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
ConnectorApi connect POST /connect Connect a new even processor
ConnectorApi delete_connector POST /disconnect Remove a connector from the hawk repository
ConnectorApi get_connectors GET /connectors Return a list of connected producer/consumers
TrackApi track POST /track Record an individual event

Documentation For Models

Documentation For Authorization


  • Type: API key
  • API key parameter name: api_key
  • Location: HTTP header