python-pagerduty: Clients for PagerDuty’s APIs

External Resources

• GitHub Repository

• PyPI Project Page

• PagerDuty Developer Documentation

• PagerDuty API References

Table of Contents

• Changelog
• User Guide
  • Installation
  • Command Line Interface
  • Authentication
    • Using Non-US Service Regions
    • The From header
    • Performing an OAuth Exchange to Obtain an Access Token
    • Performing OAuth Token Refresh Automatically
  • Basic Usage Examples
    • REST API v2
    • Events API v2
  • Generic Client Features
  • URLs
  • Query Parameters
  • Requests and Responses
    • Data types
    • Resource Schemas
  • Entity Wrapping
    • Identifying Wrapped-entity Endpoints
    • Wrapped-entity-aware Functions
    • Special Cases
    • Examples
  • Pagination
    • Retrieving Large Historical Datasets
    • Non-Standard Pagination Styles
    • Performance and Completeness of Results
    • Updating, creating or deleting while paginating
  • Multi-updating
  • Error Handling
  • Logging
  • Using a Proxy Server
  • HTTP Retry Configuration
    • Default Behavior
    • Exponential Cooldown
    • Configuring Retry Behavior
• PDPYRAS Migration Guide
  • Client Classes
  • Exception Classes
• Module Reference
  • API Client Classes
    • ApiClient
    • OAuthTokenClient
    • RestApiV2Client
    • EventsApiV2Client
  • Errors
    • Error
    • HttpError
    • ServerHttpError
    • UrlError
  • Client Defaults
    • CANONICAL_PATHS
    • CURSOR_BASED_PAGINATION_PATHS
    • ENTITY_WRAPPER_CONFIG
    • ITERATION_LIMIT
    • TEXT_LEN_LIMIT
    • TIMEOUT
  • Functions
    • URL Handling
    • Entity Wrapping
    • Function Decorators
    • Helpers
• Contribution Guide
  • Initial Setup
  • Maintaining Entity Wrapper Configuration
    • Introduction
    • Limitations
    • Updating the Canonical Path Set
    • Evaluating New Endpoints For Support
    • Adding Support for Non-Conforming Endpoints
  • Updating Documentation
  • Releasing a New Version
    • Perform end-to-end publish and installation testing
    • Merge changes and tag
    • Publishing