{"_id":"5a5fc8285476ef002aa4578f","project":"564e5930c3553e0d003e53d0","version":{"_id":"564e5a9b1560880d008d30dc","project":"564e5930c3553e0d003e53d0","__v":26,"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","59ca65ca4337830026edf24f","5c33cd9eb47ba20051ac8d64","5c33df728bec1d0063431c34","5c4783ef523219027055513a","5c4f35033400f3010203a999"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Foundation","version_clean":"2.0.0","version":"2"},"category":{"_id":"5c33cd9eb47ba20051ac8d64","project":"564e5930c3553e0d003e53d0","version":"564e5a9b1560880d008d30dc","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2019-01-07T22:07:26.642Z","from_sync":false,"order":3,"slug":"rest-api-v1","title":"REST API v1 (Legacy)"},"user":"59e10aa4bf9ac7001a235dd6","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-01-17T22:03:20.139Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"On October 19, 2018, REST API v1 was fully decommissioned and is no longer operational.\",\n  \"title\": \"REST API v1 Now Fully Decommissioned\"\n}\n[/block]\nIn July 2016, PagerDuty released REST API v2 and announced plans to decommission the REST API v1. This is separate from our Events API which will not be affected. [Learn more about the differences between our APIs here](doc:getting-started).\n\n## What happened?\n\nOn April 24, 2018, REST API v1 entered a decommissioning period. On October 19, 2018, REST API v1 was fully decommissioned and is no longer operational. \n\nPagerDuty users are no longer able generate new REST API v1 keys. No new PagerDuty features will be available for REST API v1.\n\n## Will existing REST API v1 keys continue to work with v2?\n\nOnly if you specify version 2 in the header of your request like so:\n\n```\nAccept: application/vnd.pagerduty+json;version=2\n```\n\nWithout this `Accept` header, REST API v1 keys will not work with REST API v2.\n\n## Will Events API v1 still be supported?\n\nThis change only affects REST API v1. You can continue to use Events API v1 as you do today.[Learn more about our the differences between our APIs here](doc:getting-started).\n\n## I'm using REST API v1 with a PagerDuty integration. How do I upgrade?\n\nMost of these integrations have been updated to use REST API v2. [Check the \"Steps To Upgrade\" column on this integration list](doc:v1-rest-api-integrations-update) to see what steps are needed (if any) to upgrade. For those that are not yet upgraded, please use the contact in the last column to check on the status.\n\n[v1 REST API Integrations Update Status Page](doc:v1-rest-api-integrations-update)\n\n## Why should I upgrade to REST API v2?\n\nREST API v2 provides new endpoints, event normalization, and is easier to use with streamlined API calls, consistent naming, interactive documentation, and much more. [Learn more about v2 by visiting our FAQs page.](doc:api-v2-frequently-asked-questions)\n\n## Can I use a REST API v1 key with v2?\n\nYes, you can continue to use existing keys if you specify the API version you'd like to use in the `Accept` header:\n\n```\nAccept: application/vnd.pagerduty+json;version=2\n```\n\n[Read our Migration Guide for more information](doc:migrating-to-api-v2)\n\n## How do I know which of my REST API keys default to v1?\n\nEach REST API key has a default version which is used if you do not specify your version in the request header. See [Versioning](doc:versioning) for details on how this works.\n\n### Account Level API Keys\n\nAccount owners or admins can see the full list of REST API keys on an account by navigating to **Configuration → API Access**. The **API Version** column specifies which REST API version the API key uses *by default*. Look for keys with \"v1 Legacy\" in the API Version column.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e5b9503-api_table.png\",\n        \"api table.png\",\n        1888,\n        318,\n        \"#f6f6f6\"\n      ]\n    }\n  ]\n}\n[/block]\n### User Level API Keys\n\nYour account may have user level API keys enabled. You can check this by navigating to your User Settings. Click your avatar in the top right corner of your PagerDuty account and select **My Profile**. Once on your profile page, select the **User Settings** tab. If you see an API Access section on this tab, user level API keys are enabled on your account. You should see a similar table where you can check the default version of each key you have created. Each user on your account can manage their user level API tokens on this page.\n\nOnly REST API keys are displayed on the **API Access** page. Events API keys are integration keys and can be found on the **Integrations** tab of each individual service. The Events API will not be impacted by the decommissioning of REST API v1.\n\n## Where can I go for support?\n\nIf you haven’t migrated to REST API v2 yet, we encourage you to get started with the [migration guide](doc:migrating-to-api-v2) that walks you through the process. Please reach out to the [community](https://community.pagerduty.com/c/dev?utm_source=web&utm_campaign=dev_rest_v1_faq&utm_medium=link) or contact our support team at support:::at:::pagerduty.com if you have questions or encounter problems.\n\n## Special Note To ServiceNow Customers\n\nWhen REST API v1 is decommissioned on October 19, 2018, version 3.2.1 of the ServiceNow integration will no longer be operational. If you are using this version, you should plan for an upgrade of your ServiceNow integration. [More information can be found here](https://community.pagerduty.com/t/whats-new-pagerduty-v4-integration-for-servicenow/1019?utm_source=web&utm_campaign=dev_rest_v1_faq&utm_medium=link).","excerpt":"","slug":"v1-rest-api-decommissioning-faq","type":"basic","title":"REST API v1 Decommissioning FAQ"}

REST API v1 Decommissioning FAQ


[block:callout] { "type": "danger", "body": "On October 19, 2018, REST API v1 was fully decommissioned and is no longer operational.", "title": "REST API v1 Now Fully Decommissioned" } [/block] In July 2016, PagerDuty released REST API v2 and announced plans to decommission the REST API v1. This is separate from our Events API which will not be affected. [Learn more about the differences between our APIs here](doc:getting-started). ## What happened? On April 24, 2018, REST API v1 entered a decommissioning period. On October 19, 2018, REST API v1 was fully decommissioned and is no longer operational. PagerDuty users are no longer able generate new REST API v1 keys. No new PagerDuty features will be available for REST API v1. ## Will existing REST API v1 keys continue to work with v2? Only if you specify version 2 in the header of your request like so: ``` Accept: application/vnd.pagerduty+json;version=2 ``` Without this `Accept` header, REST API v1 keys will not work with REST API v2. ## Will Events API v1 still be supported? This change only affects REST API v1. You can continue to use Events API v1 as you do today.[Learn more about our the differences between our APIs here](doc:getting-started). ## I'm using REST API v1 with a PagerDuty integration. How do I upgrade? Most of these integrations have been updated to use REST API v2. [Check the "Steps To Upgrade" column on this integration list](doc:v1-rest-api-integrations-update) to see what steps are needed (if any) to upgrade. For those that are not yet upgraded, please use the contact in the last column to check on the status. [v1 REST API Integrations Update Status Page](doc:v1-rest-api-integrations-update) ## Why should I upgrade to REST API v2? REST API v2 provides new endpoints, event normalization, and is easier to use with streamlined API calls, consistent naming, interactive documentation, and much more. [Learn more about v2 by visiting our FAQs page.](doc:api-v2-frequently-asked-questions) ## Can I use a REST API v1 key with v2? Yes, you can continue to use existing keys if you specify the API version you'd like to use in the `Accept` header: ``` Accept: application/vnd.pagerduty+json;version=2 ``` [Read our Migration Guide for more information](doc:migrating-to-api-v2) ## How do I know which of my REST API keys default to v1? Each REST API key has a default version which is used if you do not specify your version in the request header. See [Versioning](doc:versioning) for details on how this works. ### Account Level API Keys Account owners or admins can see the full list of REST API keys on an account by navigating to **Configuration → API Access**. The **API Version** column specifies which REST API version the API key uses *by default*. Look for keys with "v1 Legacy" in the API Version column. [block:image] { "images": [ { "image": [ "https://files.readme.io/e5b9503-api_table.png", "api table.png", 1888, 318, "#f6f6f6" ] } ] } [/block] ### User Level API Keys Your account may have user level API keys enabled. You can check this by navigating to your User Settings. Click your avatar in the top right corner of your PagerDuty account and select **My Profile**. Once on your profile page, select the **User Settings** tab. If you see an API Access section on this tab, user level API keys are enabled on your account. You should see a similar table where you can check the default version of each key you have created. Each user on your account can manage their user level API tokens on this page. Only REST API keys are displayed on the **API Access** page. Events API keys are integration keys and can be found on the **Integrations** tab of each individual service. The Events API will not be impacted by the decommissioning of REST API v1. ## Where can I go for support? If you haven’t migrated to REST API v2 yet, we encourage you to get started with the [migration guide](doc:migrating-to-api-v2) that walks you through the process. Please reach out to the [community](https://community.pagerduty.com/c/dev?utm_source=web&utm_campaign=dev_rest_v1_faq&utm_medium=link) or contact our support team at support@pagerduty.com if you have questions or encounter problems. ## Special Note To ServiceNow Customers When REST API v1 is decommissioned on October 19, 2018, version 3.2.1 of the ServiceNow integration will no longer be operational. If you are using this version, you should plan for an upgrade of your ServiceNow integration. [More information can be found here](https://community.pagerduty.com/t/whats-new-pagerduty-v4-integration-for-servicenow/1019?utm_source=web&utm_campaign=dev_rest_v1_faq&utm_medium=link).