What is the Vansah API?
Vansah is a test management application for Atlassian Jira Cloud. The Vansah Connect REST API lets developers and testers send test results, manage test cases, test runs, test plans and folder structures into Jira from outside the User Interface.
Common use cases:
Publishing automated test results from CI/CD, integrating with frameworks such as Selenium, Playwright, Cypress, TestNG, JUnit, Cucumber, syncing data and building custom dashboards or reporting pipelines.
Official Postman collection: https://apidocs.vansah.com
Who this sheet is for
For Developers | For Testers & QA |
Build & integrate • Wire test result reporting into CI/CD (GitHub Actions, Jenkins, Bitbucket Pipelines) • Call endpoints from Selenium / Playwright / Cypress hooks • Use the Java or Postman binding so you don't hand-roll HTTP • Push results from REST API tests (Postman / Newman) • Pull data into BI dashboards | Explore & validate • Try every endpoint live in Postman before raising a dev ticket • Confirm a result was logged correctly against the right Jira issue / sprint / release • Bulk-create or update test runs without clicking through the UI • Generate ad-hoc reports for a sprint review • Reproduce automation failures by replaying API calls |
Authentication
Every Vansah API call is authenticated with a workspace-specific API token, sent in the request header.
Generating a token
• In Jira, open Apps → Vansah → Settings → Vansah API Tokens
• Click Create API Token, give it a memorable label, click Create
• Copy the token immediately, it cannot be retrieved later. You can create up to
Sending the token
Include the token in the Authorization header on every request:
Authorization: <your-vansah-token> Content-Type: application/json
Security tip: treat tokens like passwords. Store them in environment variables, CI/CD secrets, or a secrets manager — never commit them. Rotate tokens if a teammate leaves or if you suspect exposure.
Base URL confirm yours
Vansah is hosted with data-residency support in multiple regions (USA, Canada, UK, EU, Australia, Singapore). The base URL you call depends on where your Jira workspace is pinned.
Always grab the exact URL from Apps → Vansah → Settings → Vansah API Tokens at the time you create the token.
Region (Jira pinned location) | Base URL |
USA | |
Australia | |
Canada | |
Europe | |
Singapore | |
UK |
What the API can do
The Postman collection groups endpoints by resource. The table below is the practical map, match what you want to do to a group, then open that folder in the collection.
Group | What it covers |
Test Cases | Create, read, update and delete Test Cases. Manage Test Steps, expected results, custom fields, labels and links to Jira issues. |
Test Runs | Create a Test Run against a Jira issue, a Test Folder, an Advanced Test Plan (ATP) or a Standard Test Plan (STP). Read, update, transition status, and delete runs. |
Test Logs | Add or update the result of a Test Step inside a Test Run — pass / fail / N/A / not tested — with comments and screenshot attachments. Supports quick (overall) results and detailed per-step results. |
Test Folders | Manage the folder tree used to organise Test Cases, e.g. "regression/2026/login". Create, list and remove folders. |
Test Plans | Work with Advanced Test Plans (ATP — structured by folder or issue) and Standard Test Plans (STP — flat grouping). Used to scope and report on a release or cycle. |
Releases & Sprints | Tag test activity with a Release name and Sprint name so reporting and BI dashboards roll up correctly. |
Environments | Associate Test Runs with an environment (QA, UAT, Staging, Prod) for filtering and traceability. |
Attachments | Upload screenshots or files against a Test Log for evidence. |
Official bindings & integrations
Rather than calling the REST API directly, you can use a Vansah-maintained binding for your framework. These are thin wrappers that handle headers, retries and the common workflows.
• Java, VansahNode (JUnit, TestNG, Selenium, Playwright Java, Cucumber JVM, Maven)
• JavaScript / Node for Cypress, Playwright (JS) and Postman / Newman
• Python for pytest, Robot Framework and Behave
• C# / .NET for NUnit, MSTest, SpecFlow and TestComplete
• CI / no-code UiPath, Opkey, Jenkins, GitHub Actions, Bitbucket Pipelines, ServiceNow
Browse the full integration list at vansah.com/connect-integrations
Conventions, tips and common pitfalls
• Project key vs Test Case key. Jira work item keys look like KAN-1. Vansah Test Case keys use a C: KAN-C17. Test Plan keys use a P: KAN-P18. Mixing them up is the #1 cause of 4xx errors.
• Folder paths. Must contain at least one / and must NOT start with /. Example: regression/2026/login.
• Result values. Accepted as strings ("passed", "failed") OR integers (0 = N/A, 1 = Fail, 2 = Pass, 3 = Not Tested). Pick one style and stick to it across your suite.
• Step row index. The testStepRow parameter on test logs is 1-based and must match the order of steps in the Test Case. Out-of-range values silently log against the wrong step.
• Screenshots. Pass either a File object or a file path. Large attachments slow the call — capture targeted screenshots, not full-page when not needed.
• Idempotency. Creating a new test run with the same identifiers creates a new run each time. If your CI may retry, guard against duplicate runs (e.g. by updating an existing run instead of creating one).
• Rate & batching. For large suites, batch logs after the run rather than streaming each step in real time; this reduces failed builds caused by transient network errors.