{"__v":14,"_id":"56c51da4ba4a540d0091b9b7","category":{"__v":13,"_id":"56a96d338791090d00113bab","pages":["56a96d492bb3910d000ee931","56c3cec2106c12170020db96","56c51da4ba4a540d0091b9b7","56c51dc3ba4a540d0091b9b9","56c51eb916c7190d00ff7b19","56c51ec2d7b9ed19008d1752","56c51eec668eb01900719bcd","56c51effba4a540d0091b9bb","56c51f1cf7c4da0d00614b02","56c51f2a8dc1c51900abc142","56c51f367de3580d00bdaf2a","56c67b6270e7660d004a8985","56c67b7cfd00bb0d0016daad"],"project":"564e5930c3553e0d003e53d0","version":"564e5a9b1560880d008d30dc","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-28T01:21:55.716Z","from_sync":false,"order":1,"slug":"patterns","title":"REST API"},"parentDoc":null,"project":"564e5930c3553e0d003e53d0","user":"564e5788230d7c1700c9073e","version":{"__v":21,"_id":"564e5a9b1560880d008d30dc","project":"564e5930c3553e0d003e53d0","createdAt":"2015-11-19T23:26:19.166Z","releaseDate":"2015-11-19T23:26:19.166Z","categories":["564e5a9b1560880d008d30dd","566318e1f5ca460d00f41896","56631d08cd54d50d005015fa","56631d2a81ad7417006a202c","5668ba19fbd7680d009375f4","5668cb8b10bda80d00797ed9","5668cb9d10bda80d00797eda","56830d8a3f94e00d004e2a7a","56830d9072bb720d0091f594","56830d94cb4d190d0027698e","56830dc44aecbd0d00a464c5","569e90f3c9b43e0d00c4bab1","56a96d338791090d00113bab","56b12d8336d2580d00247877","56c36bf0a869d017002ea55b","56c36bf93d30210d00ea84bb","56c77749b935671700ff0304","56c7ab9e5652c217008e091a","56cb8bdad5c6241d00ef5e61","58aefce02470660f00b54539","58aefd0bebd7370f0078b954"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"Foundation","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-18T01:25:56.099Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"The PagerDuty 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](doc:events-api) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What and Where\"\n}\n[/block]\nThe API is designed around RESTful principles. It's based on managing [resources](doc:resource-schemas)  via the HTTP methods `GET`, `POST`, `PUT`, and `DELETE`.\n\nAll requests to the REST API are made to the same host:\n```\napi.pagerduty.com\n```\nBased on the [authentication](doc:authentication) that you provide, you'll receive data for the associated account.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"How\"\n}\n[/block]\nOnly JSON is supported in the API. Request bodies should supply JSON data and responses will come back as JSON. Other content types are currently not supported and may produce unpredictable results.\n\nConsult the topics on the left to learn more about the conventions of REST API v2.\n\nIf you're comfortable with the layout and structure of the API, or want to get started right away, head over to the [API Reference](page:api-reference). The reference documentation contains a comprehensive set of REST API [endpoints](doc:endpoints), parameters, and responses. You'll be able to find the resources you need and try making API requests right from your browser!","excerpt":"Care and feeding of your PagerDuty REST API","slug":"rest-api","type":"basic","title":"Overview"}

Overview

Care and feeding of your PagerDuty REST API

The PagerDuty 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](doc:events-api) [block:api-header] { "type": "basic", "title": "What and Where" } [/block] The API is designed around RESTful principles. It's based on managing [resources](doc:resource-schemas) 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](doc:authentication) that you provide, you'll receive data for the associated account. [block:api-header] { "type": "basic", "title": "How" } [/block] Only JSON is supported in the API. Request bodies should supply JSON data and responses will come back as JSON. Other content types are currently not supported and may produce unpredictable results. Consult the topics on the left to learn more about the conventions of REST API v2. 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](page:api-reference). The reference documentation contains a comprehensive set of REST API [endpoints](doc:endpoints), parameters, and responses. You'll be able to find the resources you need and try making API requests right from your browser!