API Keys

Unflakable uses API keys to authenticate requests made by the test framework plugins to determine which tests are currently quarantined and to report new test results.

This page covers the following topics:

  1. Creating an API key
  2. Viewing API keys
  3. Renaming an API key
  4. Deleting an API key

LinkCreating an API key

To create an API key:

  1. Visit the Team SettingsNew tab page.
  2. Click the Add API Key button in the API Keys section labeled with a plus sign (+). The New API Key dialog will appear.
  3. Enter a name for the API key that will help you identify where it is used (e.g., API key for CI).
  4. Click ADD to create the API key. A dialog will appear with the API key secret.
  5. Copy the API key to your clipboard by clicking the Copy icon ( Copy to Clipboard ), and store it somewhere secure.

LinkViewing API keys

To view the current API keys associated with your team, visit the Team SettingsNew tab page and refer to the API Keys section.

LinkRenaming an API key

To rename an API key:

  1. Visit the Team SettingsNew tab page.
  2. Click the Rename icon ( ) in the API Keys section next to the key you would like to rename. The Update API Key dialog will appear.
  3. Enter the desired API key name.
  4. Click SUBMIT to confirm the change.

LinkDeleting an API key

To delete an API key:

  1. Visit the Team SettingsNew tab page.
  2. Click the Delete icon ( ) in the API Keys section next to the API key you would like to delete. A confirmation dialog will appear.
  3. Click DELETE to confirm.