Skip to content

01-Overview.md

Latest commit

 

History

History
47 lines (31 loc) · 3.21 KB

01-Overview.md

File metadata and controls

47 lines (31 loc) · 3.21 KB
Raw
tags
rest-api

REST API v2 Overview

Importing Pagerduty OpenAPI Specs into Postman

  • The "Run in Postman" Button was removed in favor of this more concrete workflow as described in Postman's documentation on integrating Postman with OpenAPI
  • Use this URL in the OpenAPI import tool to integrate Postman with OpenAPI

The REST API provides a way for third parties to connect to a PagerDuty account and access or manipulate configuration data on that account. It is not for connecting your monitoring tools to send events to PagerDuty; for that, use the Events API.

What and Where

This API is designed around RESTful principles. It's based on managing resources via the HTTP methods GET, POST, PUT, and DELETE.

All requests to the REST API are made to the same host:

api.pagerduty.com

Based on the authentication that you provide, you'll receive data for the associated account.

How

Only JSON is supported in the REST API. Other content types are currently not supported and may produce unpredictable results. Request bodies should supply JSON data and responses will come back as JSON.

Consult the topics on the left to learn more about the conventions of the REST API.

If you're comfortable with the layout and structure of the API, or want to get started right away, head over to the API Reference. The reference documentation contains a comprehensive set of REST API endpoints, parameters, and responses. You'll be able to find the resources you need and try making requests right from your browser!

HTTP Request Headers

The following headers should be set as applicable when making HTTP requests to the REST API:

  • Accept: to optionally specify a different API version than the version of the API token; see Versioning.
  • Authorization: required for all requests; see Authentication.
  • Content-Type: required when making a POST or PUT request. The MIME media type should be application/json.
  • From: the email address of the user to record as having taken the action. Should be used when creating a user or when performing Incident Creation in the REST API.

TLS

Connecting to the PagerDuty REST API requires using TLS (Transport Layer Security).

Currently, our REST API supports TLS protocol versions 1.2.

Our server certificate is issued and signed by DigiCert. Client systems will need to have an up-to-date certificate bundle that includes DigiCert root certificates in their local trust store. CA certificates, if needed, can be obtained directly from DigiCert.