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:8080/v2
export SURVEIL_AUTH_URL=http://localhost:8080/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:8080/v2',
                  auth_url='http://localhost:8080/v2/auth',
                  version='2_0')
hosts = c.config.hosts.list()

How to use it

Config-host-update:

surveil config-host-update [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.5.1.tar.gz (17.8 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for python-surveilclient-0.5.1.tar.gz
Algorithm Hash digest
SHA256 5c636fcb9bd60dfd44482b5bfd73e39489f4a3d6c3d6da88fa9cbac03e83ddc0
MD5 41cae82d9eec5c42fde42c7f33b7b298
BLAKE2b-256 bd971035606e711d07dabc728c1ce51b4dc5d943fe6233a0550db664bacf43fd

See more details on using hashes here.

Provenance

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