Skip to main content

Surveil API Client Library

Project description

This is a client library for Surveil built on the Surveil API.

Command-line API

Installing this package gets you a shell command, surveil, that you can use to interact with the Surveil API.

You’ll need to provide the Surveil API URL. You can do this with the --surveil-api-url parameter, but it’s easier to just set it as environment variable:

export SURVEIL_API_URL=http://localhost:5311/v2
export SURVEIL_AUTH_URL=http://localhost:5311/v2/auth

You’ll find complete documentation on the shell by running surveil help.

Bash completion

Basic command tab completion can be enabled by sourcing the bash completion script:

source /usr/local/share/surveil.bash_completion

Python API

To use the python API, simply create a client with the endpoint:

from surveilclient import client
c = client.Client('http://localhost:5311/v2',
                  auth_url='http://localhost:5311/v2/auth',
                  version='2_0')
hosts = c.config.hosts.list()

How to use it

Config-host-update:

surveil config-host-update --host_name [host_name] --address [ADDRESS] --custom_fields '{"_field1": "value1", "_field2": "value2"}'

Project details


Download files

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

Source Distribution

python-surveilclient-0.13.3.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

python_surveilclient-0.13.3-py2-none-any.whl (235.8 kB view details)

Uploaded Python 2

File details

Details for the file python-surveilclient-0.13.3.tar.gz.

File metadata

File hashes

Hashes for python-surveilclient-0.13.3.tar.gz
Algorithm Hash digest
SHA256 3e745eacb7679c83a43312545c1a090786263c500519a06ad43724f33fc69144
MD5 81775eee0ef5ce3f9b05cb6c342380dc
BLAKE2b-256 ef5da66fb96bf73bb447c1f38fbe079c86d3e2cdfec7f0a020d3e83b7efc03fc

See more details on using hashes here.

File details

Details for the file python_surveilclient-0.13.3-py2-none-any.whl.

File metadata

File hashes

Hashes for python_surveilclient-0.13.3-py2-none-any.whl
Algorithm Hash digest
SHA256 c6923839daeda6f5e09497f2cff1e0ed1bf7981d8b8256556abfd8c78841e002
MD5 34f1ca0fbfe7790ec546b0ebdc7dd910
BLAKE2b-256 5320355615a991ec4386e8ebfd62efea005c00a40777c8d2b19f850ac502f842

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page