REST API (overview)

Applies to Zephyr Scale Cloud, last modified on November 20, 2020.

You can import data, store test-automation execution results, or integrate any automated testing tools with Zephyr Scale's API (REST). The HTTP-based REST API can be used from any framework, programming language, or tool.

Submitting data to Zephyr Scale via the REST API is done with simple POST/PUT requests. Requesting data is done with GET requests.

The base URL for API requests is{endpoint}

We've released the main API functionality that revolves around publishing test results to Zephyr Scale Cloud. 

After this release, we'll continue to develop API features, like adding endpoints to create test scripts for test cases and more.

If you have suggestions for our API development priorities, raise a request through our Support Desk.

To begin using the REST API:

  • Review the API documentation for details on available endpoints and data models for the API. 
  • Create access keys for each user who will be interfacing with the API.
    See Generating Access Keys for details.

When you post a test-execution result using the API and include a username, it appears as a manual execution. This design allows you to mark an execution as manual, even if it has been added via the API.

Highlight search results