API Access Token Management

How to Generate the Token

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

Note

Each user interacting with the API will need a token for that instance of Jira.

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

    access_token_Jira.png
  2. Click Create access token. A pop-up window appears.

    create-token.png
  3. Click the copy button to copy the access token.

    copy-access-token-xN0.png

Now you're set to get started with using the REST API!

The URL for API requests is: https://prod-api.zephyr4jiracloud.com/v2/{endpoint}

The authorization we use is based on JWT, so you have to use a bearer token. Add the "Authorization" header with the value "Bearer {token}".

Revoke the token

Zephyr Squad allows you to revoke old tokens.

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

  2. Select the Revoke option.

    ZS_Screenshot_token2.png
  3. Click Revoke. Your token is now deactivated. You will not able to perform any API call with deactivated token.

Publication date: