Troubleshoot REST API Issues

Applies to Zephyr Scale Cloud, last modified on April 01, 2021.

As we continue to improve the API for Zephyr Scale Cloud, you may experience some minor issues as you begin to use the new features.

If you find an issue, please raise a ticket through our Support Desk, including screenshots, error messages, etc., so we can address it as soon as possible.

Here are some common issues that you may experience while using the REST API, and some solutions:

I'm getting a 401 - Unauthorized response.

Verify that you've selected Authorization: Bearer {bearer_token} and added your access key from Zephyr Scale API key generator.
See Generating Access Keys for more information.

I'm getting a 404 - Not Found response.

Verify that you're using the correct base URL for accessing the API. The base URL is not your Jira instance URL but the one provided by Zephyr Scale: https://api.tm4j.smartbear.com/rest-api/v2/{endpoint}
The 404 - Not Found response is also returned if an object, such as a test case, cannot be found. 

I'm getting a 403 - Forbidden response.

Verify that you're using the correct endpoint. For example, a common mistake is to reference /testexecution instead of /testexecutions. If the endpoint is incorrect, you'll receive a 403 response.
You also receive this response if your API Access Key is invalid/incorrect or if you have not provided any credentials when attempting to access the API.

I'm getting a 400 - Bad Request response.

Verify that you've included all of the required fields in your request.
For example, for the POST /testexecutions endpoint, you must include the projectKey field as shown in the API documentation.

Suggested Improvements/Missing Functionality

We’re continuously reviewing improvements to the Zephyr Scale REST API, and encourage you to make any suggestions in our Ideas Portal here

In the meantime, to see a list of current suggestions and missing functionality, check out the API section of our Ideas Portal here.

Highlight search results