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"}'
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file python-surveilclient-0.13.2.tar.gz.
File metadata
- Download URL: python-surveilclient-0.13.2.tar.gz
- Upload date:
- Size: 30.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cb503625dbeb11748b8b0469e9efa8bee7dc9777014d99c66d6abef3bdf4120f |
|
| MD5 | c723014f92ecbdd58196b1e422bc14c9 |
|
| BLAKE2b-256 | 6d4fc2a0b67e9adead976840d9174ac4af3758ee6f88e702d9250fbcded56da7 |
Provenance
File details
Details for the file python_surveilclient-0.13.2-py2-none-any.whl.
File metadata
- Download URL: python_surveilclient-0.13.2-py2-none-any.whl
- Upload date:
- Size: 75.0 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5e10a07a8040b14bf20e60e9a6264f96754caf23a5cfd452781f6dfc7aaa6cf1 |
|
| MD5 | 4826e4c4eb41442afe984834e97ef34e |
|
| BLAKE2b-256 | 97117e3317e9ffa071f833fe9ab42e79ecafd992304ae5386077ef3f21463d96 |
