PDPYRAS: PagerDuty Python REST API Sessions¶

DEPRECATED: Please use python-pagerduty for new projects instead, and for existing projects, refer to the PDPYRAS Migration Guide.

External Resources¶

  • GitHub Repository

  • PyPI Project Page

  • PagerDuty REST API v2: Documentation / API Reference

  • PagerDuty Events API v2: Documentation / API Reference

Table of Contents¶

  • Changelog
  • User Guide
    • Installation
    • Authentication
      • The From header
      • Using Non-US Service Regions
    • Basic Usage Examples
      • REST API v2
      • Events API v2
    • Generic Client Features
    • URLs
    • Query Parameters
    • Requests and Responses
      • Data types
      • Resource schemas
    • Entity Wrapping
      • Wrapped-entity-aware Functions
      • Classic Patterns
      • Special Cases
    • Pagination
      • 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
      • Setting the retry property
  • Module Reference
    • API Client Classes
      • PDSession
      • APISession
      • EventsAPISession
      • ChangeEventsAPISession
    • Errors
      • PDClientError
      • PDHTTPError
      • PDServerError
      • 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
    • Running Unit Tests
    • Updating Documentation
    • Releasing a New Version
      • Perform end-to-end publish and installation testing
      • Merge changes and tag
      • Publishing

Quick search

Table of Contents

  • Changelog
  • User Guide
  • Module Reference
  • Contribution Guide
©2023, PagerDuty Inc.. | Powered by Sphinx 7.1.2 & Alabaster 0.7.12 | Page source