There are two APIs that you can generate API keys for:
- The REST API provides a way for third parties to connect to a PagerDuty account and access or manipulate configuration data on that account.
- The Events API v2 allows you to add PagerDuty's advanced event and incident management functionality to any system that can make an outbound HTTP connection.
For more information on the differences between the APIs, check out our article on the differences between our REST and Events APIs.
There are two types of REST API keys, general access and user tokens, both of which are 20-character strings. REST API keys cannot be used with the Events APIs, they can only be used for the REST API. For more information about authenticating using an API key, please consult our developer documentation.
Required User Permissions
You must have an Admin, Global Admin or Account Owner role within PagerDuty to access your API key. REST API access is only included on the Team plan or higher — API access is not included on the Starter plan.
- Go to Configuration → API Access and click Create New API Key.
- Enter a Description that will help you identify the key later on. If you would like it to be read-only, check the Read-only option.
- Click Create Key.
- A unique API key will be generated. Copy it to a safe place, as you will not have access to copy this key again. Once it has been copied, click Close. If you lose a key you will need to delete it and create a new one.
Once created, you will see your key appear in the list of keys on the API Access page, with versioning noted.
If your account has Advanced Permissions enabled, users can create personal REST API keys on the User Settings tab of their user profile. Requests made using personal REST API keys will be restricted to the user's permissions, and if a client attempts to use the key for an operation that the user in question is not permitted to perform, the API will respond with status
The Events APIs are available to all customers, and any user with a Manager role or above can generate an integration key. Both the Events API v1 and v2 use integration keys to determine which service an event should be routed to.
Integration keys are generated by creating a new service, or creating a new integration for an existing service in PagerDuty, and can be found on a service's Integrations tab: