REST API Cookbooks and Samples
Downloadable API Examples to simply plug and play in your own code.
-
Export Test Cases In Bulk
Description Sometimes there is a need to export test cases in bulk. However, when the number of test cases is too large, Cyara web UI may become unresponsive and even timeout. This article provides an example on how to do a massive test cases library ex...
-
Generating and Customizing Campaign Run Reports
The Campaign Run Report available on the Platform provides comprehensive information. Using the APIS, we can further refine these reports to our needs. The following script is a sample Python code that: Connects to the given URL and Account. Retrieve...
-
Update Dataset from PUT request without CSV file
This article shows how to update any dataset without uploading a file. If you remove rows details from the model body, it only updates the dataset name : To update the Row data, you can use the following sample model body. However, it will update...
-
Export user data into Excel
Problem: Currently there is no neat way of exporting user data from the portal. Extracting data using API: Using the API we're able to export the user data into a json file which isn't very neat for customers. Log into the Cyara Web Portal : https:/...
-
Working with Campaigns Using the Cyara API 3.0
Description Many Cyara users are asking questions on how to create and manipulate campaigns using the 3.0 API. This article provides a step by step description on how to Create, Update, Execute, and Delete Campaigns using the Cyara API 3.0. Authenticati...
-
Import Test Case with API
Description Sometimes there is a need to automate Test Case import. This article provides examples on how to do it in the following programming languages. Python PowerShell API endpoint: /v3.0/accounts/{accountId}/testcases/import Request method: POST...
-
Managing Users
Cyara provides APIs for managing users. The examples describe how to automate certain user administration tasks such as creating new users, attach or detach users from accounts, viewing list of users attached to an account, delete users, and view the li...
-
User Roles Summary
The Cyara Platform offers a range of User Roles that have different levels of access to parts of the Platform. These User Roles are configured by Cyara and can not be modified. See below for a brief description of each role and their primary use case, a...
-
API Samples
The library at the bottom of this article has been prepared for your use. It is for you to freely download to tinker with, edit, modify, build off of, implement into your own automation, and use for anything you choose. It consists of over a dozen sampl...