help.heroku.com Open in urlscan Pro
18.208.243.193  Public Scan

Submitted URL: https://help.heroku.com/PBGP6IDE/how-should-i-generate-an-api=
Effective URL: https://help.heroku.com/PBGP6IDE/how-should-i-generate-an-api-key-that-allows-me-to-use-the-heroku-platform-api
Submission: On May 04 via api from US — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

Help
 * Dashboard
 * Data
 * Dataclips
 * Elements
 * Documentation
 * Support


HOW SHOULD I GENERATE AN API KEY THAT ALLOWS ME TO USE THE HEROKU PLATFORM API?


ISSUE

Your API key has expired unexpectedly and you're receiving 403 Forbidden errors
when hitting API endpoints.


RESOLUTION

Use heroku authorizations:create for production apps, use heroku auth:token for
development.

There are multiple ways to create API keys and all of them have different
expiration policies. This is further compounded by the fact that you can
manually modify these expiration dates depending on your requirements and
whether your user account is SSO enabled.

In the Heroku Dev Center you'll see the CLI command heroku auth:token. This
command works by showing the token that is associated with the account that you
are logged into Heroku with. By default, this token expires a year after you log
in. This token will also expire if you run heroku logout from the CLI.
Furthermore, if you have SSO enabled, this token will expire 8 hours after you
login. While this command is appropriate for development, you will want to avoid
it for production use.

The Heroku Dashboard offers an API key on your Account settings if your user
account is not SSO enabled.
While this key does not have a hard-coded expiration date, it will expire
whenever your account password changes. In an enterprise context, where
passwords can be changed at a steady cadence, you may find this limitation to be
onerous.

If your account is not SSO enabled, heroku authorizations:create allows you to
create a token that expires at a specific time or never expires. You can also
use heroku authorizations:revoke to delete it immediately. Finally you can add a
description to this token, making it easier to document how the token is being
used.

We recommend that Enterprise Accounts and Teams that have enabled SSO for their
users and need a long lived token for integration maintain a user account that
is not SSO enabled to create and manage tokens.


ASK ON STACK OVERFLOW

Engage with a community of passionate experts to get the answers you need

Ask on Stack Overflow


HEROKU SUPPORT

Create a support ticket and our support experts will get back to you

Contact Heroku Support
heroku.com Blogs Careers Documentation
Terms of Service Privacy Cookies Cookie Preferences © 2022 Salesforce.com


COOKIE CONSENT MANAGER




 * GENERAL INFORMATION


 * REQUIRED COOKIES


 * FUNCTIONAL COOKIES


 * ADVERTISING COOKIES


GENERAL INFORMATION

We use three kinds of cookies on our websites: required, functional, and
advertising. You can choose whether functional and advertising cookies apply.
Click on the different cookie categories to find out more about each category
and to change the default settings.
Privacy Statement


REQUIRED COOKIES

Always Active

Required cookies are necessary for basic website functionality. Some examples
include: session cookies needed to transmit the website, authentication cookies,
and security cookies.

Cookies Details‎


FUNCTIONAL COOKIES

Functional Cookies


Functional cookies enhance functions, performance, and services on the website.
Some examples include: cookies used to analyze site traffic, cookies used for
market research, and cookies used to display advertising that is not directed to
a particular individual.

Cookies Details‎


ADVERTISING COOKIES

Advertising Cookies


Advertising cookies track activity across websites in order to understand a
viewer’s interests, and direct them specific marketing. Some examples include:
cookies used for remarketing, or interest-based advertising.

Cookies Details‎


BACK BUTTONBACK



Vendor Search
Filter Button
Consent Leg.Interest
checkbox label label
checkbox label label
checkbox label label

 * View Third Party Cookies
    * Name
      cookie name


Clear
checkbox label label
Apply Cancel
Save Settings
Accept All Cookies


We use cookies to make your interactions with our website more meaningful. They
help us better understand how our websites are used, so we can tailor content
for you. For more information about the different cookies we are using, read the
Privacy Statement. To change your cookie settings and preferences, click the
Cookie Consent Manager button.

Reject All Cookies Accept All Cookies
Cookie Consent Manager