Activate ReadyAPI on Headless Machines and in CI/CD build runs

Applies to ReadyAPI 3.10, last modified on September 23, 2021

This page is related to new SmartBear ID-based licenses that we’ve introduced in ReadyAPI 3.8.1.
For information on regular file-based licenses that are also used in version 3.10, see File-Based Licenses.

Running ReadyAPI on a headless machine means that it works from the command line. The same happens when you run ReadyAPI and its test runners from a CI/CD build.

To specify the SmartBear account to be used for the run, you add certain parameters to the command line. See below for details.

ReadyAPI licenses to which this info applies

The explanation below works for both Fixed User and Floating types of ReadyAPI SmartBear ID-based licenses.

Requirements

The computer where you are going to run tests must have access to the SmartBear License Servers. The proxies and firewalls running in our network should allow connection to them:

  • https://manage.smartbear.com:443
  • https://api.slm.manage.smartbear.com:443

Option 1 — Activate with email and password

To specify the SmartBear account for the run, add the -email (or -U) and -password (or -V) parameters:

ReadyAPI.exe "c:\my tests\my-proj.xml" -email john@example.com -password p12345
ReadyAPI.exe "c:\my tests\my-proj.xml" -U john@example.com -V p12345

testrunner.bat "c:\my tests\my-proj.xml" -email john@example.com -password p12345
testrunner.bat "c:\my tests\my-proj.xml" -U john@example.com -V p12345

Note: The test engine doesn’t store these parameters’ values on your computer. You need to specify them for every run.

Option 2 — Activate with access key

A more secure way to specify the SmartBear account for the run is to use an access key generated for your account.

1. Get the access key

You get the key in the SmartBear Licensing Portal:

Getting access key

For complete information, see Get Access Key in the Licensing Portal documentation.

2. Specify the access key in the command line

Use the -accessKey command-line parameter (or -K key for short):

ReadyAPI.exe "c:\my tests\my-proj.xml" -accessKey "9a######-####-####-####-##########97"
ReadyAPI.exe "c:\my tests\my-proj.xml" -K "9a######-####-####-####-##########97"

testrunner.bat "c:\my tests\my-proj.xml" -accessKey "9a######-####-####-####-##########97"
testrunner.bat "c:\my tests\my-proj.xml" -K "9a######-####-####-####-##########97"

Make sure to enclose the access key in quotes.

The test engine doesn’t cache the access key on your computer. You need to specify it for every run.

See Also

SmartBear ID-based Licenses (Early Access)
Activate and Use ReadyAPI
Getting Access Key

Highlight search results