Overview
The Heroku Platform API provides full programmatic control over your Heroku apps, dynos, add-ons, pipelines, and configuration variables. It allows DevOps engineers and CI/CD systems to automate deployments, scale dynos, manage environment secrets, and inspect release history. Authentication is via OAuth tokens or API keys passed as Bearer tokens in the Authorization header.
Beginner Tip
You can get your personal API token from the Heroku CLI by running heroku auth:token, or from the Heroku Dashboard under Account Settings. All requests must include the Accept: application/vnd.heroku+json; version=3 header — without it you will receive a 422 error. Start with the apps list endpoint to verify your authentication is working before attempting write operations.
Available Data
Example Response
{
"status": "success",
"data": {
"result": "Data from Heroku",
"description": "REST API to programmatically create apps, provision add-ons and perform other task on Heroku",
"timestamp": "2025-01-15T10:00:00Z"
}
} Field Reference
id UUID uniquely identifying the Heroku resource (app, dyno, release, etc.). name Human-readable name of the app, used in URLs and CLI commands. web_url The public HTTPS URL where the deployed application is accessible. region.name The Heroku region where the app is hosted, such as us or eu. released_at ISO 8601 timestamp of the most recent release of the app. slug Information about the compiled slug (build artifact) currently deployed to the app. Implementation Example
const url = "https://devcenter.heroku.com/articles/platform-api-reference/";
// Replace headers or query params with the values required by this API.
const response = await fetch(url, {
headers: {
"Authorization": "Bearer YOUR_API_KEY"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data); What Can You Build?
Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.
Common Errors & Troubleshooting
Matrix Score Breakdown
Partially tested on Apr 5, 2026
Technical Specifications
Related Tags
Similar APIs
View All →Bitbucket
The Bitbucket REST API (v2) provides programmatic access to Bitbucket Cloud repositories, pull requests, pipelines, and user accounts, enabling you to automate code review workflows and integrate Bitbucket into your CI/CD toolchain.
GitHub
⭐ Beginner's PickThe GitHub REST API gives you programmatic access to nearly everything on GitHub — repositories, issues, pull requests, commits, users, organizations, GitHub Actions, and more.
Gitlab
The GitLab REST API provides comprehensive programmatic control over GitLab projects, including repositories, merge requests, pipelines, issues, CI/CD variables, and user management.
Gitter
Gitter provides programmatic access to chat for developers via REST API.
Google Docs
The Google Docs API provides full programmatic control over Google Docs documents, including reading content, inserting text, applying styles, and managing document structure.