Octopus Deploy Documentation

How to Create an API Key

Last updated

API keys allow you to access the Octopus Deploy REST API and perform tasks such as creating and deploying releases. API keys can be saved in scripts or external tools, without having to use your username and password. Each user and service account can have multiple API keys.

See the Service Accounts docs for information about creating service accounts.

Creating an API Key

You can create API keys by performing the following steps:

  1. Log into the Octopus Web Portal, click your profile image and select Profile.
  2. Click My API Keys.
  3. Click New API key, state the purpose of the API key and click Generate new.
  4. Copy the new API key to your clipboard.

Write Your Key Down
After you generate an API key, it cannot be retrieved from the Octopus Web Portal again, we store only a one-way hash of the API key. If you want to use the API key again, you need to store it in a secure place such as a password manager. Read about why we hash API keys.

Need support? We're here to help.