| Redirect | ||||
|---|---|---|---|---|
|
| Table of Contents |
|---|
About API
Zephyr Enterprise exposes its data via a REST API. You can use the API to:
- Import data from other tools to Zephyr.
- Integrate Zephyr with other applications.
- Get information about users, projects, releases, test case repositories and the underlying folders, test cases, custom fields, execution cycles.
- Create new test case folders, test cases, requirements, execution cycles, execution phases.
- Add/modify/delete attachments and phases of existing execution cycles.
- Assign test execution schedules.
- Update test cases and test case execution status.
- Create an execution cycle and update the status of a test case execution run.
- Run quick search and Advanced Search (use ZQL).
- And more.
Reference
An API reference in the API Blueprint format is available here:
...
Most API operations require authentication. Zephyr Enterprise API supports the following methods of authenticating requests:
- API tokens (supported since v. 6.6)
- Basic authentication
- Cookie authentication
| Info |
|---|
If your Zephyr Enterprise instance uses single sign-on, you must use API tokens. If Zephyr is configured with internal authentication, you can use any of the API authentication methods. |
...
Note: Basic authentication requires that the username and password consist of ASCII characters. If they contain non-ASCII characters, use an API token instead.
| Anchor | ||||
|---|---|---|---|---|
|
...
http(s)://SERVER[:PORT]/flex/services/rest/latest/manifest
with a Basic authentication header containing your Zephyr username and password.
...
Cookies expire after 90 minutes, after which you will get a 401 response from the API. At this point, you will need to get a new cookie for use in subsequent requests.
Use cases
- Migrate Data to Zephyr Enterprise
- Manage Parser Templates (used to parse XML reports created by test automation tools like JUnit)
...