Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Zephyr for Jira Server


exposes its data via a REST


API which allows you to access the data programmatically and build your own


Children Display

What is ZAPI?

ZAPI (or Zephyr API) is an Add-on to Zephyr for Jira that allows access to its testing data including the ability to view and upload information programmatically.


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 for Jira Server or create


a test execution cycle and update the status of a test execution run after


it has been executed in an automation tool.


Previously, to access Zephyr for Jira Server 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.


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

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.

Getting Started

There are a few quick things to be aware of about ZAPI:
  • ZAPI works only with Zephyr for Jira Server versions 2 and higher
  • A valid license of Zephyr for Jira Server is needed for ZAPI to work
  • ZAPI is only available for Zephyr for Jira Server
  • The API is entirely HTTP-based
  • Parameters have certain expectations
  • There are pagination limits
  • Encoding affects status character counts
  • No anonymous access is allowed; the security model is the same as that of Zephyr for Jira (which in turn uses Jira's security model)



ZAPI Technical Documentation

Detailed and interactive ZAPI Server documentation provides all the details a developer would need for each of the API calls that are supported with code samples available in cURL, C#, JavaScript, Node.js, Python, PHP, and Ruby.


Base URL

The base URL for API calls is:


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

Rate limits

  • 1,000 requests per hour.

  • 24,000 requests per day.


  • 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.


Check out the Zephyr


for Jira community for the latest news, FAQs, samples and discussions.