Generating an API Key

Follow

Depending on the type of API key you are creating, for more information about authenticating using an API key, please consult the related documentation for v1 or v2.

Most integrations will require a v1 API key. For more information on the differences between the APIs, check out our article on What is the difference between the APIs?

Note: You must be an admin or account owner within PagerDuty to access your API key. Also, your plan has to be on at least the Basic plan; API access is not included on the Lite plan.

  1. Go to the Configuration menu and select API Access. Click Create New API Key.

    APIKeys_img1.png

  2. Enter a Description that will help you identify the key later on.

  3. Select the version of the API you will be using (v1 or v2) and whether you want it to be a read-only key, then click Create Key. Many integrations, especially older ones will require a v1 API key. For more information on the difference between v1 and v2, and which API key you should create, check out this article.

    APIKeys_img2.png

  4. A unique API key will be generated. Copy it to a safe place and click Close.

    Once you click Close you will be asked to confirm that you copied the API key. This is your last chance to copy the key; you will only be able to see the last 4 character of the key in the PagerDuty interface after you confirm. If you lose a key you will need to delete it and create a new one.

    APIKeys_img3.png

Once created, you will see your key appear in the list of keys on the API Access page, with versioning noted.

APIKeys_img4.png

Have more questions? Submit a request

Comments

  • Avatar
    Senthil Kumar

    Hi, I'm in "user" role and I sign in with pagerduty account. Do I have to admin to generate api key? Why the restriction?

  • Avatar
    Jonathan Curry

    Hi Senthil,

    Right now only admins and the account owner can create API keys because the API gives you admin-level access to the account. If there are specific API calls you would like to make as a user or limited user, please email support@pagerduty.com and we'll be happy to submit a feature request to our product team for you.

    Cheers,

    Jonathan

  • Avatar
    Priyata Singh

    It is documented very well. Just follow and do it and get the result. Good Work!!