Skip to main content

Panopta API Client

Project description

Panopta API Python Package
The Panopta API (previously `panopta_rest_api`) provides full access to all configuration, status and outage
management functionality of the Panopta monitoring service, including the
ability to create and modify monitoring checks that are being performed, manage
notification configuration, respond to active outages and to pull availability
statistics for monitored servers. This package makes it simple to interact with
the Panopta API.

# API Documentation
Full documentation for the API is available at
By entering your API token you can view full details on all of the API methods
and issue API requests from the documentation page.

# Installation
pip install panopta_api

# Usage
The library provides a wrapper around the Panopta API, making it easy to issue
GET, POST, PUT and DELETE operations to the API. The `Client` is an adapter
built on top of [Requests](, so anything you can do
with a `requests.Session`, you can with `panopta_api.Client`.

## Instantiate the Panopta API client
from panopta_api import Client
client = Client('your-api-key',

## Generate API urls
resource = 'server'
id = '123'
collection = 'network_service'
server_network_services = client.url(resource, id, collection)

## GET
five_contacts = client.get(client.url('contact'), params={'limit': 5});

servers_with_a_certain_fully_qualified_domain_name = client.get(
params={'fqdn': ''}

server_forty_two = client.get(client.url('server', '42'))

new_notification_schedule =
json={'name': 'New Notification Schedule',
'targets': [server_forty_two['url']]}

## PUT
updated_server_group = client.put(
json={'name': 'Updated Server Group',
'notification_schedule': new_notification_schedule['url']}

client.delete(client.url('contact', '1'))

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

panopta_api-2.0.0.tar.gz (2.8 kB view hashes)

Uploaded Source

Built Distribution

panopta_api-2.0.0-py2.py3-none-any.whl (5.0 kB view hashes)

Uploaded Python 2 Python 3

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