Create and start a test run

Creates a test run from the configuration in the request body and starts it
now. Use it when you do not have a saved schedule. The response is the new
test run; use its id to follow, cancel and report on the run.

The easiest way to build runConfigurationEntries is to copy them from a
schedule that already runs the tests you want (GET /v2/schedules/{id}).

Do not send a schedule object. With it, this request saves a schedule
instead of starting a run, and the response id is not a test-run ID.

Requires the TestRun:Create permission. If the request times out, check
the test-run list before you retry: the run may already exist.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The test run to create and start. Copy runConfigurationEntries from a
schedule that already runs the tests you want.

string
required
string
required

AUTOMATION_UI for automated tests, MANUAL for manual tests.

int64

Test repository ID. Required for manual runs.

uuid

User who runs a manual test run.

string

Katalon Runtime Engine version for automated runs, for example latest.

integer

Run timeout in minutes.

int64
int64
runConfigurationEntries
array of objects
required
runConfigurationEntries*
Headers
uuid

Account UUID. Optional; send it to select the account explicitly.

int64

Organization ID. Optional; send it to select the organization explicitly.

int64
required

Project ID. Required on every request; without it the request returns 400.

Responses

400

The request is invalid. No response-body schema is asserted.

401

Authentication is missing or invalid. No response-body schema is asserted.

403

The API key does not have permission for this project or resource, or the ID is of the wrong type.

404

The resource does not exist in this project.

default

Any other error.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Choose an example:
application/json