REST API

Applies to Zephyr Squad Server 6.0 and 4.6, last modified on May 06, 2021

Zephyr Squad exposes its data via a REST API which allows you to access the data programmatically and build your own integrations. The API is entirely HTTP-based. You can use the API to:

  • Integrate with test automation tools.

  • Integrate with continuous integration tools.

  • Create extensive custom reports for testing.

  • Integrate with business intelligence tools.

  • Use the testing data for other purposes.

For example, you can build an integration that would create a test in a separate tool or system and add it to Zephyr Squad or create a test execution cycle and update the status of a test execution run after it has been executed in an automation tool.

Note:

Previously, to access Zephyr Squad REST API, you had to install an additional plugin (ZAPI). As of October 2020, the API is available out-of-the-box, and the ZAPI plugin is no longer needed.

Reference

Follow the link below to view the API documentation along with code examples for cURL, C#, JavaScript, Node.js, Python, PHP, and Ruby.

https://zephyrsquadserver.docs.apiary.io

Using the API, you can:

  • Get information about users, projects, releases, tests and execution cycles.

  • Create new tests and test execution cycles.

  • Update tests and test execution status.

  • Add attachments to existing execution cycles.

  • Run ZQL queries and retrieve search results.

Base URL

The base URL for API calls is:

http://SERVER[:PORT]/jira/rest/zapi/latest

For example, POST /jira/rest/zapi/latest/cycle means a POST request to http://localhost:2990/jira/rest/zapi/latest/cycle, which creates a new cycle.

JSON requests

Most operations that accept a request body expect it in the JSON format.

POST and PUT request containing a JSON request body must include the Content-Type header:

Content-Type: application/json

Remarks

  • There are pagination limits.

  • Encoding affects status character counts.

Got questions?

Check out the Knowledge Base developer section on the support site to get your questions answered or to see samples.

Community

Check out the Zephyr Squad community for the latest news, FAQs, samples and discussions.

See Also

Terms and Concepts
Explore the User Interface

Highlight search results