Skip to main content

At a glance

Credentials

Set these per environment. See Connect an integration.

Setup

  1. Sign in to Heroku: Go to https://dashboard.heroku.com and sign in (an Eco/Basic app is enough for testing; SSO-federated users must use a separate non-federated account for API tokens).
  2. Create an API token: With the Heroku CLI, run ‘heroku authorizations:create -d “veryfront token”’ for a non-expiring OAuth token, or ‘heroku auth:token’ for a token valid up to one year.
  3. Set the environment variable: Add the token to your .env as HEROKU_API_KEY=…
  4. Verify access: Run List Apps, then List Dynos with one of your app names.
  • Every request must send ‘Accept: application/vnd.heroku+json; version=3’ - tools include this header by default
  • Restarting dynos uses the DELETE method (DELETE /apps/{app}/dynos restarts all dynos; it does not delete the app)
  • List endpoints paginate with Range/Next-Range headers (max 1000 items per page) and return 206 Partial Content when truncated
Provider API reference: https://devcenter.heroku.com/articles/platform-api-reference

Tools

Example prompts

  • List the dynos of my Heroku app and tell me if any are crashed or not in the ‘up’ state.
  • Show the latest releases of my Heroku app and who deployed them.