API
Warning
This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out this blog post and the HCP Waypoint documentation.
Waypoint comes with a full HTTP API which lets you write your own integrations
for managing your own applications and projects. This API comes with an OpenAPI
2.0 (Swagger) specification which can be used to generate HTTP clients in any
language using only the specification. This API is served on the same port as
Waypoint's UI and every call is prefixed with /v1 on self-managed Waypoint
and /waypoint/2022-02-03/namespace/{namespace_id} for HCP.
An up-to-date version of this specification can be found on Github.
We have also provided an example Waypoint-client in Go for getting started today with Waypoint's HTTP API in your own projects.
Authentication
Waypoint's HTTP API requires authentication for any methods in which the
underlying gRPC method would require a Waypoint token. In order to start making
calls with Waypoint's HTTP API, you must provide a valid Waypoint token in the
Authentication header for each request.
HCP
Using the Waypoint HTTP API on HCP requires the base path to be modified to contain your specific namespace ID before any API calls will be successful. An example on how to retrieve this ID for HCP is available in our Waypoint-client in Go.