Skip to main content

Heroku

Heroku is a cloud platform as a service (PaaS) that enables developers to build, deploy, run, and manage applications entirely in the cloud. This data integration platform provides comprehensive visibility into Heroku infrastructure, applications, and associated resources, allowing teams to query and monitor their platform deployments, configurations, and operational state.

CategoryCloud
DirectionQuery source
Sign-inAPI Key
Query languagesSQLite
Tables12
Query templates29
Websiteheroku.com

Before you start​

Huntbase signs in to Heroku with API Key. Create the credential in Heroku first, then keep it to hand for the Connect step.

  1. If your account doesn't use SSO, open Account settings in the Heroku Dashboard and copy the API Key.
  2. For a long-lived token that doesn't change with your password, run heroku authorizations:create in the Heroku CLI instead, and copy the token it returns.
Watch out for
  • The Dashboard API key regenerates when you change your password, which breaks the connection. Tokens from heroku authorizations:create avoid this.
  • Tokens from heroku auth:token are short-lived. They expire after one year, or after 8 hours with SSO.

For the vendor's own instructions, see Heroku API key documentation.

tip

Use a dedicated, read-only credential for Huntbase where the product allows it. Huntbase only needs to read.

Connect Heroku​

  1. Go to Connections and click New connection, or click New connection on the Heroku product page.
  2. On Product, pick Heroku and choose the Owner.
  3. On Details, give the connection a Name and, optionally, a Description.
  4. On Connect, fill in the settings and credentials described below.
  5. On Verify, review the summary and click Create & check.

For everything else on the setup page — saving a draft, I'll do this later, and what each check result means — see Connections.

Settings​

Where your Heroku lives:

FieldRequiredNotes
Account EmailNoThe email address of the Heroku user the API key belongs to.

Credentials​

The only Method is API Key. Enter a Credential label (for example Production), then fill in:

FieldRequiredNotes
API KeyYesSecret — not shown again after you save it.

Query it​

Once connected, Heroku can serve these languages in a query tab, and Scout can use it when you ask in Auto:

LanguageUse it for
SQLiteSQL over the 12 tables listed below, alongside every other connected source.

Example: SQLite​

List all keys — Explore the full range of keys available within your Heroku account.

select
  *
from
  heroku_key;

Heroku ships with 29 query templates. Find them in Library › Queries — see Query templates.

Tables​

Heroku adds 12 tables. Browse their columns from Schema in the query bar's ⋯ menu.

All 12 tables
TableContains
heroku_accountAn account represents an individual signed up to use the Heroku platform.
heroku_addonAdd-ons are components, services, or pieces of infrastructure that are fully maintained for you, either by a third-party provider or by Heroku.
heroku_appAn app represents the program that you would like to deploy and run on Heroku.
heroku_app_releaseA release represents a combination of code, config vars and add-ons for an app on Heroku.
heroku_app_webhookWebhooks define what web routes should be routed to an app on Heroku.
heroku_domainDomains define what web routes should be routed to an app on Heroku.
heroku_dynoDynos encapsulate running processes of an app on Heroku.
heroku_keyKeys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations.
heroku_pipelineA pipeline allows grouping of apps into different stages.
heroku_regionA region represents a geographic location in which your application may run.
heroku_teamTeams allow you to manage access to a shared group of applications and other resources.
heroku_team_memberA team member is an individual with access to a team.

Next steps​