Generating API Access and Secret Keys

Applies to Zephyr Squad Cloud, last modified on January 13, 2022

Access and secret keys are used to interact with the Zephyr Squad Cloud data via API. Each user has their own pair of access and secret keys. The keys have the same permissions as the user they belong to.

Generate access and secret keys

  1. In Jira Cloud, go to Apps > Zephyr Squad.

  2. Click API Keys in the sidebar on the left:

    Open API keys dialog

    Click the image to enlarge it.

  3. If you have not yet generated API keys, you will see a dialog box that suggests generating them. Click Generate new key:

    Generate new key
  4. Copy your access and secret keys:

    Generate new API keys

    Click the image to enlarge it.

Regenerate secret key

If you suspect the keys have been compromised, you can revoke the secret key and generate a new one.

  1. In Jira Cloud, go to Apps > Zephyr Squad.

  2. Click API Keys in the sidebar on the left.

  3. Click  Regenerate. This immediately revokes the old secret key and generates a new one:

    Generate new API keys

    Click the image to enlarge it.

    Note: The access key remains the same, and only the secret key is regenerated.
  4. Copy the new secret key and update your applications or scripts to use the new key.

See Also

Zephyr Squad Cloud REST API

Highlight search results