


"description": "The platform API empowers developers to automate, extend and combine Heroku with other services.",ĬURL examples are provided to facilitate experimentation. H "Accept: application/vnd.heroku+json version=3" You can access the schema using cURL: $ curl \ The API has a machine-readable JSON schema that describes what resources are available via the API, what their URLs are, how they are represented and what operations they support. The Platform API supports cross-origin resource sharing (CORS) so that requests can be sent from browsers using JavaScript served from any domain. Clients should specify a User-Agent header to facilitate tracking and debugging. ClientsĬlients must address requests to using HTTPS and specify the Accept: application/vnd.heroku+json version=3 Accept header. If the resource has changed, the request will proceed normally. If the resource has not changed, a 304 Not Modified status will be returned with an empty body. You may use this value to check for changes to a resource by repeating the request and passing the ETag value in the If-None-Match header.

CachingĪll responses include an ETag (or Entity Tag) header, identifying the specific version of a returned resource. HTTP bearer authentication must be constructed using an API token, passed as the Authorization header for each request, for example Authorization: Bearer 01234567-89ab-cdef-0123-456789abcdef. Details can be found in the OAuth article.įor personal scripts you may also use HTTP bearer authentication, but OAuth is recommended for any third party services. OAuth should be used to authorize and revoke access to your account to yourself and third parties.

For details on getting started, see Getting Started with the Platform API. You can use the platform API to programmatically create apps, provision add-ons and perform other tasks that could previously only be accomplished with the Heroku CLI or Dashboard. The platform API empowers developers to automate, extend and combine Heroku with other services.
