In order to interact with the API, an API key is required.

  1. Navigate to your user's Settings page
  1. On the right side of the page, enter a name in the API key name text field

  2. Click the Create API Key button

  3. Copy the generated API key value - this is the only time the value will be available

⚠️

CAUTION

Treat all API keys like passwords and do not commit them to code or share them with unauthorized parties

Access for an API key can be revoked by clicking the Delete button next to its name in the list.

Include this key in a X-Shipyard-API-Key header in requests in order to be properly authorized to invoke the API.