Skip to main content

Python Client Library for PagerDuty's REST API

Project description


Python Library for PagerDuty’s v1 REST API.

This library is currently evolving and backwards compatibility cannot always be guaranteed at this time.


You can install with pip install pygerduty.

If you want to install from source, then python install.


Pygerduty is tested against >= Python 2.5

simplejson is required on Python2.5


Pygerduty is a thin wrapper around PagerDuty’s APIs. You will need to refer to the the PagerDuty Documentation for all available parameters to pass and all available attributes on responses.

The main methods available to resources are list, show, create, update, and delete. Not all resources have endpoints for all of the above methods. Again, refer to the PagerDuty Documentation to see all available endpoints.

Top level resources will be accessible via the PagerDuty object and nested resources available on containers returned from their parent resource.


Instantiating a client:

import pygerduty
pager = pygerduty.PagerDuty("foobar", "SOMEAPIKEY123456")

Listing a resource:

for schedule in pager.schedules.list():

# PX7F8S3 Primary
# PJ48C0S Tertiary
# PCJ94SK Secondary

Getting a resource by ID:

schedule ="PX7F8S3")

Creating a resource:

user = next(pager.users.list(query="gary", limit=1))
override = schedule.overrides.create(
    start="2012-12-16", end="2012-12-17",

Delete a resource:


Updating a resource:

pagerduty.users.update(, name="Gary Example")

Acknowledging a group by incidents:

me = next(pager.users.list(query="", limit=1))
for incident in pagerduty.incidents.list(status='triggered'):

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

pygerduty-py3-0.28.2.tar.gz (8.8 kB view hashes)

Uploaded Source

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