API keys and authentication

Waypoint uses a Username and Password pair to allow access to the API through Basic HTTP Authentication (this is not the same as your Waypoint dashboard username/password).

To access or create a new API key:

  1. Go to the 'Settings' page of your workspace.
  2. Scroll down to the 'API keys' section, click on '+ Add key', and then follow the directions to finish adding the key.
  3. After creating the key, scroll down to the bottom of the 'Settings' page and you should now see your new API key with a Username and Password that can be used in the authorization header within your API call.

To get started using the API, we recommend following our quick start guide.