Skip to main content

Finding Your Vansah API Connect URL

Find your workspace’s Vansah API base URL, configure it with an API token, and use it in an authenticated REST request.

Your Vansah API Connect URL is the base address your integration uses to call the Vansah REST API. Configure your automation tool, CI/CD pipeline, or script with this URL and a valid Vansah API token.

Use the value shown for your own workspace. Workspaces can use different regional Vansah hosts.

Find your API Connect URL

  1. In Jira, open Apps → Vansah.

  2. Select the Settings gear in Vansah.

  3. Open Vansah API Tokens.

  4. Copy the base URL displayed in the introductory text above the token list.

Vansah API Tokens screen showing the workspace API Connect URL above the token list

The screenshot shows an example URL. Copy the value displayed in your workspace rather than copying the screenshot’s address.

You can view this URL on the token list screen. To create or replace a token, follow Creating a Vansah API Token.

Configure your integration

Connection value

How to use it

API Connect URL

Set the tool’s base URL or API URL to the value copied from Vansah. Avoid adding an endpoint path to a field that expects only the base URL.

Vansah API token

Provide the complete token through your integration’s token or credential setting.

Endpoint path

For a direct REST request, append the path for the operation you need, such as /api/v2/category/caseTypes.

Jira space key

Provide the destination space key in the fields required by the endpoint. API names such as projectKey and project.key both refer to the Jira space key.

For direct REST requests, send the Vansah token as the Authorization header value, without a Bearer prefix. Use the endpoint’s documented method, headers, and request fields.

Example: list Test Case types

In Bash, set VANSAH_URL to your copied base URL without a trailing slash and VANSAH_TOKEN to your API token. Replace DEMO with a Jira space key your account can access.

curl --request GET --get \
--url "$VANSAH_URL/api/v2/category/caseTypes" \
--header "Authorization: $VANSAH_TOKEN" \
--header "Accept: application/json" \
--data-urlencode "projectKey=DEMO" \
--data-urlencode "startAt=0" \
--data-urlencode "limit=100"

A successful response includes success: true, pagination details, and a data array of Test Case types. See List Test Case Types for the complete response and pagination guidance.

Troubleshoot a connection

Problem

What to check

Invalid or expired token

Check the complete token, its expiry date, and whether it has been revoked. Create a replacement when required and update the integration’s stored value.

Workspace or region mismatch

Compare the configured URL with the value currently shown in Vansah API Tokens for the intended Jira site.

Endpoint cannot be found

Check the API method and full path. Avoid repeating /api/v2 when your tool already adds it.

Permission or Jira space error

Check that the token account can access the Jira space and has the permission required for that operation.

An older integration no longer connects

Configure it with a token created through the current Vansah token process and check its request paths against the API documentation.

Related guides

Did this answer your question?