Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rainforest QA runs API

Operations about runs

Rainforest QA runs API is one of 18 APIs that Rainforest QA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include runs. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 15 operations across 12 paths, and defines 29 schemas. It is described by OpenAPI 3.0.0, at version 1.

Requests are made against a single base URL, https://app.rainforestqa.com/api.

15 operations 12 paths 29 schemas 1 DELETE9 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1
Base URL
https://app.rainforestqa.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rainforest QA runs API declares 1 security scheme for authenticating requests. An API key is passed in the header as CLIENT_TOKEN (api_key). By default, every request must be authenticated.

Paths & Operations 15

Across 12 paths, the API surfaces 15 operations — 1 DELETE, 9 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

runs 15

Operations about runs

POST
/1/runs
Create a new run
post-runs body → 201400
GET
/1/runs
List runs
get-runs 19 params → 200400
GET
/1/runs/{run_id}/tests/{test_id}
Get a test from a run
get-run-test 3 params → 200404
GET
/1/runs/historical_usage
Get historical credit usage for runs
get-runs-historical_usage 2 params → 200
GET
/1/runs/{run_id}
Get a run
get-run 2 params → 200404
PUT
/1/runs/{run_id}
Update a run
put-run 1 param body → 200404409
DELETE
/1/runs/{run_id}
Cancel a run
delete-run 1 param → 200404409
GET
/1/runs/{run_id}/junit
Get a run's JUnit XML
get-run-junit 1 param → 200400404
GET
/1/runs/{run_id}/usages
List usages for a run
get-run-usages 1 param → 200404
POST
/1/runs/{run_id}/rerun_all
Create a rerun
post-run-rerun_all 1 param body → 201400404
POST
/1/runs/{run_id}/rerun_failed
Create a rerun
post-run-rerun_failed 1 param body → 201400404
GET
/1/runs/{run_id}/tests
List tests for a run
get-run-tests 29 params → 200404
POST
/1/runs/{run_id}/tests/mark_as_viewed
Mark tests as viewed
post-run-tests-mark_as_viewed 1 param body → 201404
GET
/1/runs/{run_id}/tests/{test_id}/comments
List comments for a run test
get-run-test-comments 2 params → 200404
GET
/1/runs/{run_id}/steps/{step_id}
Get a step from a run
get-run-test-step 5 params → 200404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Tests_RunTestsIndex (40 properties), Run (40 properties), Runs_Index (34 properties), post-runs (30 properties). Each schema is shown below with its type and property counts.

RunStep
object
RunStep model
11 properties
RunProgress
object
7 properties
TestCommentHistory
object
TestCommentHistory model
10 properties
RunTestReview
object
15 properties
Tests_Lite
object
16 properties
Connection
object
Connection model
7 properties
Worker
object
Worker model
7 properties
post-run-rerun_all
object
Rerun all tests from a previous run
2 properties
post-runs
object
Create a new run
30 properties
post-run-rerun_failed
object
Rerun failed tests from a previous run
2 properties
UserLite
object
6 properties
put-run
object
Update a run
1 property
Tests_RunTestsIndex
object
TestsRunTestsIndex model
40 properties
Profile
object
3 properties
Environment
object
Environment model
10 properties 6 required
RunBrowser
object
4 properties
Error
object
Error model
1 property 1 required
Branch
object
4 properties
Tests_RunTestsLite
object
30 properties
post-run-tests-mark_as_viewed
object
Mark test results as viewed
1 property 1 required
RunUsage
object
RunUsage model
2 properties
User
object
User model
14 properties
RunStats
object
4 properties
SiteEnvironment
object
5 properties 3 required
Run
object
Run model
40 properties
RunCost
object
RunCost model
5 properties
Runs_Index
object
RunsIndex model
34 properties
RunTestBrowserStatus
object
9 properties
OverriddenResult
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rainforest-qa-runs-api-openapi.yml Raw ↑

Other APIs Rainforest QA publishes across the network.

Rainforest QA callback API
Rainforest QA clients API
Rainforest QA connections API
Rainforest QA credit_cards API
Rainforest QA environments API
Rainforest QA features API
Rainforest QA folders API
Rainforest QA generators API
Rainforest QA on_premise_crowd API
Rainforest QA run_groups API
Rainforest QA site_environments API
Rainforest QA sites API