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

Operations about environments

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

This API exposes 5 operations across 2 paths, and defines 5 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.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 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 environments 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 5

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

environments 5

Operations about environments

GET
/1/environments
List environments
get-environments 3 params → 200
POST
/1/environments
Create a new environment
post-environments body → 201400
GET
/1/environments/{environment_id}
Get an environment
get-environment 1 param → 200404
PUT
/1/environments/{environment_id}
Update an environment
put-environment 1 param body → 200400404
DELETE
/1/environments/{environment_id}
Delete an environment
delete-environment 1 param → 200400404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Environment (10 properties), post-environments (6 properties), SiteEnvironment (5 properties), put-environment (4 properties). Each schema is shown below with its type and property counts.

Environment
object
Environment model
10 properties 6 required
put-environment
object
Update an environment
4 properties
Error
object
Error model
1 property 1 required
post-environments
object
Create a new environment and corresponding site-environments for each site as well
6 properties 1 required
SiteEnvironment
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rainforest-qa-environments-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 features API
Rainforest QA folders API
Rainforest QA generators API
Rainforest QA on_premise_crowd API
Rainforest QA run_groups API
Rainforest QA runs API
Rainforest QA site_environments API
Rainforest QA sites API