Zephyr for Jira Cloud exposes its data via a REST APIs which allows you to access the data programmatically and build your own integrations. 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.
The API provides the following capabilities:
- Get information about users, projects, releases, tests, execution cycles.
- Create new tests and test execution cycles.
- Update tests, test execution status.
- Add attachments to existing execution cycles.
- Run ZQL queries and retrieve search results.
For example, you could build an integration that would create a test in a separate tool/system and add it to Zephyr for Jira Cloud or create an test execution cycle and update the status of a test execution run after its has been executed in an automation tool.
Reference
Interactive API documentation is available at the following link, along with code examples in cURL, C#, JavaScript, Python, and other languages.
Rate Limits
- 1,000 requests per hour.
- 24,000 requests per day.
Authentication
All API calls require authentication using JWT access tokens. For details, see Generate a JWT Authentication Token and Execute APIs in ZAPI Cloud.
Remarks
- There are pagination limits.
- Encoding affects status character counts.