Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Python SDK for OpsGenie Web/REST API (Criteo Forks)

Project description

Aim and Scope

OpsGenie Python SDK aims to access OpsGenie Web API through HTTP calls from a client application in Python language.

OpsGenie Python SDK covers:

  • Alert API

Future releases are subject to be delivered for packing more APIs soon.

For more information about OpsGenie Python SDK, please refer to OpsGenie Python API document.

Pre-requisites

  • The API is specifically built for Python 2.7 but can also be used with other Python versions.
  • Before you begin, you need to sign up OpsGenie if you don’t have a valid account yet. Create an API Integration and get your API key.

Installation

To download all packages in the repo with their dependencies, simply execute

pip install opsgenie-sdk

Getting Started

One can start using OpsGenie Python SDK by initializing client and making a request. Example shown below demonstrates how to initialize our Swagger client and make a create alert request.

from opsgenie.swagger_client import AlertApi
from opsgenie.swagger_client import configuration
from opsgenie.swagger_client.models import CreateAlertRequest
from opsgenie.swagger_client.rest import ApiException

configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'GenieKey'

try:
    response = AlertApi().create_alert(body=CreateAlertRequest(message='Hello from OpsGenie Python SDK'))

    print('request id: {}'.format(response.request_id))
    print('took: {}'.format(response.took))
    print('result: {}'.format(response.result))
except ApiException as err:
    print("Exception when calling AlertApi->create_alert: %s\n" % err)

There are useful sample code snippets under samples directory for packages. At the moment, we are continuing to support our old OpsGenie client for creating alerts to new REST API:

from opsgenie import OpsGenie
from opsgenie.swagger_client import CreateAlertRequest
from opsgenie.config import Configuration
from opsgenie.swagger_client.rest import ApiException

config = Configuration(apikey="YOUR_API_KEY")

client = OpsGenie(config)

try:
    response = client.alert_v2.create_alert(CreateAlertRequest(message="Hello from OpsGenie Python SDK"))
    print 'message: {}'.format(response.message)
    print 'alert id: {}'.format(response.alert_id)
    print 'status: {}'.format(response.status)
    print 'code: {}'.format(response.code)
except ApiException as err:
    print("Exception when calling alert_v2->create_alert: %s\n" % err)

The Web API

Please follow the links below for more information and details about the Web API.

Bug Reporting and Feature Requests

If you like to report a bug, or a feature request; please open an issue.

Project details


Release history Release notifications

This version
History Node

0.3.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
opsgenie-sdk-criteo-0.3.1.tar.gz (54.0 kB) Copy SHA256 hash SHA256 Source None Oct 2, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page