Zephyr Squad Cloud exposes its data via a REST API 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.
For example, you could build an integration that would create a test in a separate tool/system and add it to Zephyr Squad or create an test execution cycle and update the status of a test execution run after its has been executed in an automation tool.
|To create, run, and manage Test Automation jobs, use the Test Automation API instead.|
|Note:||Previously, to access Zephyr Squad REST API you had to install an additional plugin (ZAPI). As of August 2020, the API is available out-of-the-box, and the ZAPI plugin is no longer needed.|
The API provides the following capabilities:
Get information about tests, test cycles, test executions.
Create new tests and test execution cycles.
Update tests and test execution status.
Add attachments to existing execution cycles.
Run ZQL queries and get search results.
The base URL for API calls is:
POST /public/rest/api/1.0/attachment means a POST request to
The API uses JWT tokens for authentication. All requests must include the following headers:
Authorization: JWT GENERATED_JWT_TOKEN
YOUR_ACCESS_KEYis the access key found in the API Keys section of Zephyr Squad Cloud.
GENERATED_JWT_TOKENis the JWT token generated for this specific request. To learn how to generate JWT tokens, see this page.
JWT tokens are generated using several pieces of information, including the API endpoint you want to call, and query parameters (if any). This means that to call multiple different endpoints or call the same endpoint but with different query parameters you must generate a new JWT token for each API call.
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
1,000 requests per hour.
24,000 requests per day.
There are pagination limits.
Encoding affects status character counts.