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 run_groups API

Operations about run_groups

Rainforest QA run_groups 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 run_groups. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 13 operations across 6 paths, and defines 25 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.

13 operations 6 paths 25 schemas 3 DELETE5 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 run_groups 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 13

Across 6 paths, the API surfaces 13 operations — 3 DELETE, 5 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

run_groups 13

Operations about rungroups

GET
/1/run_groups
List run groups
get-run_groups 4 params → 200
POST
/1/run_groups
Create a new run group
post-run_groups body → 201400
POST
/1/run_groups/{id}/elements/batch
Add multiple elements to a run group
post-run_group-elements-batch 1 param body → 201400404
DELETE
/1/run_groups/{id}/elements/batch
Remove multiple elements from a run group
delete-run_group-elements-batch 4 params → 200404
GET
/1/run_groups/{id}
Get a run group
get-run_group 1 param → 200404
PUT
/1/run_groups/{id}
Update a run group
put-run_group 1 param body → 200
DELETE
/1/run_groups/{id}
Delete a run group
delete-run_group 1 param → 200404
GET
/1/run_groups/{id}/runs
Get runs for a run group
get-run_group-runs 3 params → 200404
POST
/1/run_groups/{id}/runs
Create a new run group run
post-run_group-runs 1 param body → 201400
GET
/1/run_groups/{id}/elements
Get run group elements
get-run_group-elements 7 params → 200404
POST
/1/run_groups/{id}/elements
Add an element to a run group
post-run_group-elements 1 param body → 201400404
GET
/1/run_groups/{id}/elements/{element_id}
Get an element from a run group
get-run_group-element 2 params → 200404
DELETE
/1/run_groups/{id}/elements/{element_id}
Remove an element from a run group
delete-run_group-element 2 params → 200404

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Run (40 properties), Tests_RunTestsLite (30 properties), Tests_Lite (16 properties), RunTestReview (15 properties). Each schema is shown below with its type and property counts.

RunGroupElement
object
RunGroupElement model
6 properties
RunProgress
object
7 properties
Schedule
object
4 properties
RunTestReview
object
15 properties
Tests_Lite
object
16 properties
Connection
object
Connection model
7 properties
RunGroup
object
RunGroup model
11 properties
post-run_groups
object
Create a new run group
7 properties 1 required
Ok
object
Ok model
1 property
UserLite
object
6 properties
post-run_group-elements-batch
object
Add multiple elements to a run group
1 property 1 required
post-run_group-runs
object
Create a new run group run
9 properties
Profile
object
3 properties
put-run_group
object
Update a run group
7 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
post-run_group-elements
object
Add an element to a run group
3 properties 1 required
Tests_RunTestsLite
object
30 properties
User
object
User model
14 properties
RunStats
object
4 properties
SiteEnvironment
object
5 properties 3 required
Run
object
Run model
40 properties
ScheduleRule
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rainforest-qa-run-groups-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 runs API
Rainforest QA site_environments API
Rainforest QA sites API