Create a Vansah API token to connect an integration, script or automation tool to the Vansah REST API. The current process uses Atlassian sign-in to authorize the connection.
You do not need to enter a Jira email address and a separate Jira API token in the creation form. Follow the Atlassian sign-in prompts, then create and copy your Vansah token.
Before you begin
Open Jira with the Atlassian account you want to use for the integration.
Make sure you can access Vansah on the intended Jira site.
Choose a unique label for the token and a future expiry date within the next year.
Have a secure place ready to store the token, such as your organization’s approved secrets manager.
Open Vansah API Tokens
In Jira, open Apps > Vansah.
Select the Settings cog in Vansah, then choose Vansah API Tokens.
Select Create or Create API Token to open the creation form.
Create and copy your token
Enter a Label that identifies the integration, such as CI pipeline. Use a label that is not already in your token list.
Set the Expiry Date. It must be in the future and no more than one year from today.
Select Authenticate to open Atlassian sign-in.
Sign in with the intended Atlassian account, review the access request and complete authorization. If Atlassian asks you to select a Jira site, select the site from which you started creating the token.
Return to Vansah and wait for Authenticated Successfully.
Select Create.
Select Copy and store the new token securely before closing the window.
Copy it before closing: Vansah shows the generated token only during creation. You cannot retrieve the same token value later.
Use the token with your integration
The Vansah API Tokens screen also displays your API Connect URL. Configure your integration with that URL and the Vansah token you just copied.
Use the connection details shown for your own workspace. See Vansah API Connect URL and the Vansah REST API documentation for integration instructions.
Manage or replace a token
Return to Vansah API Tokens to check token labels, creation dates and expiry dates. To stop an integration from using a token, select Revoke beside that token and confirm the action.
Revocation cannot be undone. If a token has expired, has been lost or needs replacing, create another token and update the integration’s stored credentials.
Troubleshooting
Problem | What to check |
Authenticate or Create is unavailable | Enter a label and a valid future expiry date. Create also requires successful Atlassian authentication. |
Atlassian authentication does not complete | Complete the sign-in window before closing it. If the request times out or the window was closed, select Authenticate again. Check that the Atlassian sign-in window was not blocked by your browser. |
The account or Jira site does not match | Restart authentication with the Atlassian account and Jira site used to open Vansah. |
The token label is rejected | Choose a unique label, such as CI pipeline, using letters, numbers, spaces or hyphens. Keep it within 255 characters. |
Token limit reached | Review your existing token list. If the limit prevents you from creating a required token, contact Vansah support with the displayed message. |
The integration rejects the token | Check that you copied the complete Vansah token, are using the displayed API Connect URL, and the token has not expired or been revoked. |