...
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.
Authentication
All API calls require authentication using JWT access tokens. For details, see Generate a JWT Authentication Token and Execute APIs in ZAPI Cloud.
...
| Info |
|---|
To create, run, and manage Test Automation jobs, use the Test Automation API instead. |
Base URL
The base URL for API calls is:
| Code Block |
|---|
https://prod-api.zephyr4jiracloud.com/connect |
For example, POST /public/rest/api/1.0/attachment means a POST request to https://prod-api.zephyr4jiracloud.com/connect/public/rest/api/1.0/attachment.
Authentication
The API uses JWT tokens for authentication. All requests must include the following headers:
| Code Block |
|---|
zapiAccessKey: YOUR_ACCESS_KEY
Authorization: JWT GENERATED_JWT_TOKEN |
where:
YOUR_ACCESS_KEYis the access key found in the API Keys section of Zephyr for Jira Cloud.GENERATED_JWT_TOKENis the JWT token generated for this specific request. To learn how to generate JWT tokens, see this page.
| Info |
|---|
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. |
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:
| Code Block |
|---|
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?
Ask your questions in the Zephyr for Jira Cloud community, or contact Support for assistance.
See
...