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

Operations about sites

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

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

sites 5

Operations about sites

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

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Site (8 properties), post-sites (5 properties), put-site (4 properties), Error (1 property). Each schema is shown below with its type and property counts.

post-sites
object
Create a new site - creates corresponding site-environments for each environment as well
5 properties 1 required
put-site
object
Update a site
4 properties
Error
object
Error model
1 property 1 required
Site
object
Site model
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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