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

Operations about connections

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

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

7 operations 4 paths 3 schemas 1 DELETE3 GET1 POST2 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 connections 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 7

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

connections 7

Operations about connections

GET
/1/connections
List connections
get-connections 2 params → 200
POST
/1/connections
Creates a new connection
create-connection body → 201
GET
/1/connections/{id}
Get connection
get-connection 1 param → 200
PUT
/1/connections/{id}
Rename connection
rename-connection 1 param body → 200
DELETE
/1/connections/{id}
Delete connection
delete-connection 1 param → 204
GET
/1/connections/{id}/status
Get connection status
get-connection-status 1 param → 200
PUT
/1/connections/{id}/regenerate_api_token
Regenerate API token
regenerate-api-token 1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Connection (7 properties), create-connection (1 property), rename-connection (1 property). Each schema is shown below with its type and property counts.

Connection
object
Connection model
7 properties
rename-connection
object
Rename connection
1 property 1 required
create-connection
object
Create connection
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Rainforest QA publishes across the network.

Rainforest QA callback API
Rainforest QA clients 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
Rainforest QA sites API