API Access Tokens Management

How to Generate the Token

You need to generate an access token to use the API for Zephyr. The following steps illustrate the process.

Zephyr Standard/Advanced

  1. Click Settings and select General Settings.

    General Settings
  2. Under Apps section, select Zephyr API Access Tokens.

    Zephyr API Access token
  3. Click Create access token.

    ZSc_Screenshot_APIAccessToken_02.png

    A pop-up window appears.

  4. Click the copy button to copy the access token.

    64107f5267f73.png

Zephyr Essential

  1. Click your Jira profile icon and select Zephyr Essential API Access Tokens.

    Zephyr Essential API access token
  2. Click Create access token.

    ZSc_Screenshot_APIAccessToken_02.png

    A pop-up window appears.

  3. Click the copy button to copy the access token.

    64107f5267f73.png

You are all set to begin using the REST API. Now, do either of the following:

Revoke the token

Zephyr allows you to revoke old tokens.

  1. Click your Jira profile icon and select Zephyr API Access Tokens. You will see the list of the tokens created.

    ZSc_Screenshot_RevokeToken_01.png
  2. Select the Revoke option.

    ZS_Screenshot_token2.png
  3. Click Revoke.

    ZSc_Screenshot_RevokeToken_03.png

    Your token is now deactivated. You will not able to perform any API call with deactivated token.

Publication date: