API Reference
StatusChangelogApp

Create a new run

post
https://app.rainforestqa.com/api/1/runs

Create a new run

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

Only run tests with this category

Allowed:
int32

Only run created in this exploratory run

feature_id
array of int32s

Only run tests with this/these feature(s); use -1 to filter for tests without a feature

feature_id
string
enum

Only run tests with this priority

Allowed:
string

Only run tests whose title contains, or ID matches, this string

string
enum

Only run tests with a specific result

Allowed:
int32

Only run tests in this run group; use -1 to filter for tests not in any run groups

site_id
array of int32s

Only run tests for this/these site(s)

site_id
int32

Only run tests in this saved filter

state
array of strings

Only run tests that with this state

state
string

Only run tests whose steps match this string

tags
array of strings

Only run tests having all specified tags; use -1 to filter for untagged tests

tags
string

Only run tests matching this criteria. Can be comma-separated list of test ids or 'all' to run all tests

string
enum

Only run tests of this type

Allowed:
run_id
array of int32s

Only run tests that were in this/these previous run(s)

run_id
string

Only run tests that contain given variable

boolean

If true, only run tests that are embedded in other tests. If false, only run tests that are not embedded in other tests.

int32

Only run tests owned by this user; use -1 to filter for tests without an owner

string
enum

Only run tests with a specified language

Allowed:
browsers
array of strings

An array of browsers to run this against, overrides the defaults; you can find a list of possible options via the client API

browsers
string
enum

The execution method to use for this run

Allowed:
string
enum

The crowd to use for this run

Allowed:
string

An arbitrary string to associate with the run

int32

Use a specific environment for this run

string
enum
Defaults to standard

Set the run mode to standard or draft

Allowed:
string

Manually entered release information about the release the run is associated with

string

Reroute tests through a specific location for this run; values are default to turn off, usa for USA, can for Canada, deu for Germany, sgp for Singapore, and aus for Australia, or the id of a connection if you have a custom connection

string

Deprecated: please use connection.id instead

url

HTTP webhook that we will POST notifications to; we expect a confirmation callback for before_test webhooks

string
enum

How should we handle current other runs that are in progress; values are cancel to cancel runs in the same environment as your new run and cancel-all to cancel all runs

Allowed:
Responses

Updated about 13 hours ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 13 hours ago