Heroku Domains API
Custom domain management
Heroku Domains API is one of 14 APIs that Heroku publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Domains. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a getting-started guide, and authentication docs.
This API exposes 4 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 3.
Requests are made against a single base URL, https://api.heroku.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Heroku Domains API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
By default, every request must be authenticated.
BearerAuth— Heroku API key or OAuth token
Paths & Operations 4
Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Custom domain management
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Domain (11 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Heroku 12
Other APIs Heroku publishes across the network.