{
    "info": {
        "author": "Panopta",
        "author_email": "support@panopta.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "Panopta API Python Package\r\n==========================\r\nThe Panopta API (previously `panopta_rest_api`) provides full access to all configuration, status and outage\r\nmanagement functionality of the Panopta monitoring service, including the\r\nability to create and modify monitoring checks that are being performed, manage\r\nnotification configuration, respond to active outages and to pull availability\r\nstatistics for monitored servers. This package makes it simple to interact with\r\nthe Panopta API.\r\n\r\n# API Documentation\r\nFull documentation for the API is available at\r\n[https://api2.panopta.com/v2/api-docs/](https://api2.panopta.com/v2/api-docs/).\r\nBy entering your API token you can view full details on all of the API methods\r\nand issue API requests from the documentation page.\r\n\r\n# Installation\r\n```bash\r\npip install panopta_api\r\n```\r\n\r\n# Usage\r\nThe library provides a wrapper around the Panopta API, making it easy to issue\r\nGET, POST, PUT and DELETE operations to the API. The `Client` is an adapter\r\nbuilt on top of [Requests](http://python-requests.org), so anything you can do\r\nwith a `requests.Session`, you can with `panopta_api.Client`.\r\n\r\n## Instantiate the Panopta API client\r\n```python\r\nfrom panopta_api import Client\r\nclient = Client('your-api-key',\r\n                host='http://api2.panopta.com',\r\n                version='2',\r\n                log_level=Client.LOG_INFO,\r\n                log_path='logs/')\r\n```\r\n\r\n## Generate API urls\r\n```python\r\nresource = 'server'\r\nid = '123'\r\ncollection = 'network_service'\r\nserver_network_services = client.url(resource, id, collection)\r\n```\r\n\r\n## GET\r\n```python\r\nfive_contacts = client.get(client.url('contact'), params={'limit': 5});\r\n\r\nservers_with_a_certain_fully_qualified_domain_name = client.get(\r\n    client.url('server'),\r\n    params={'fqdn': 'panopta.com'}\r\n)\r\n\r\nserver_forty_two = client.get(client.url('server', '42'))\r\n```\r\n\r\n## POST\r\n```python\r\nnew_notification_schedule = client.post(\r\n    client.url('notification_schedule'),\r\n    json={'name': 'New Notification Schedule',\r\n          'targets': [server_forty_two['url']]}\r\n)\r\n```\r\n\r\n## PUT\r\n```python\r\nupdated_server_group = client.put(\r\n    client.url('server_group'),\r\n    json={'name': 'Updated Server Group',\r\n          'notification_schedule': new_notification_schedule['url']}\r\n)\r\n```\r\n\r\n## DELETE\r\n```python\r\nclient.delete(client.url('contact', '1'))\r\n```",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/Panopta/python-panopta-api-client",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "panopta-api",
        "package_url": "https://pypi.org/project/panopta-api/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/panopta-api/",
        "project_urls": {
            "Homepage": "https://github.com/Panopta/python-panopta-api-client"
        },
        "release_url": "https://pypi.org/project/panopta-api/2.0.0/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Panopta API Client",
        "version": "2.0.0"
    },
    "last_serial": 1767613,
    "releases": {
        "2.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1c87d1bdaef003d233bd2c116304b290",
                    "sha256": "944dfefdb656af298ec306460c297ba5fa50c06f47c24e4fdf216e4acfebba84"
                },
                "downloads": -1,
                "filename": "panopta_api-2.0.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "1c87d1bdaef003d233bd2c116304b290",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 4972,
                "upload_time": "2015-10-14T00:11:44",
                "url": "https://files.pythonhosted.org/packages/d2/9f/035d4dd0fd91e7bfa6b5ae5f51d4aa48a6a6e692c78eb3d17a86f49ffb5a/panopta_api-2.0.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a05b1c7ae229b11448e20763bcf7d3fc",
                    "sha256": "1a2406f34d9fb53bef99b283015b679c927ad2213f95ba11b5d101d4a22d39a9"
                },
                "downloads": -1,
                "filename": "panopta_api-2.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "a05b1c7ae229b11448e20763bcf7d3fc",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2789,
                "upload_time": "2015-10-14T00:11:55",
                "url": "https://files.pythonhosted.org/packages/c7/15/843a6b940ea08ea21d50ab33c74709df78291e4c1ab915e53869c4b6ad9f/panopta_api-2.0.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "1c87d1bdaef003d233bd2c116304b290",
                "sha256": "944dfefdb656af298ec306460c297ba5fa50c06f47c24e4fdf216e4acfebba84"
            },
            "downloads": -1,
            "filename": "panopta_api-2.0.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1c87d1bdaef003d233bd2c116304b290",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 4972,
            "upload_time": "2015-10-14T00:11:44",
            "url": "https://files.pythonhosted.org/packages/d2/9f/035d4dd0fd91e7bfa6b5ae5f51d4aa48a6a6e692c78eb3d17a86f49ffb5a/panopta_api-2.0.0-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "a05b1c7ae229b11448e20763bcf7d3fc",
                "sha256": "1a2406f34d9fb53bef99b283015b679c927ad2213f95ba11b5d101d4a22d39a9"
            },
            "downloads": -1,
            "filename": "panopta_api-2.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a05b1c7ae229b11448e20763bcf7d3fc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2789,
            "upload_time": "2015-10-14T00:11:55",
            "url": "https://files.pythonhosted.org/packages/c7/15/843a6b940ea08ea21d50ab33c74709df78291e4c1ab915e53869c4b6ad9f/panopta_api-2.0.0.tar.gz"
        }
    ]
}