Jump to Content
Guides
Recipes
API Reference
Status
Changelog
App
API Reference
Status
Changelog
App
Guides
Recipes
API Reference
The Rainforest API
All
Pages
Start typing to searchā¦
JUMP TO
Rainforest API Documentation
The Rainforest API
Authentication
Pagination
Deprecations
connections
List connections
get
Creates a new connection
post
Get connection
get
Rename connection
put
Delete connection
del
Get connection status
get
Regenerate API token
put
callback
Notify Rainforest when a run webhook callback is complete
post
clients
Fetch your account details
get
Update account information
put
Fetch usage stats
get
Select different client
post
credit_cards
List credit cards
get
environments
List environments
get
Create a new environment
post
Get an environment
get
Update an environment
put
Delete an environment
del
features
List features
get
Create a new feature
post
Get a feature
get
Update a feature
put
Delete a feature
del
Add tests to a feature
post
Remove tests from a feature
del
folders
List folders
get
Create a new folder
post
Get a folder
get
Update a folder
put
Delete a folder
del
generators
List generators
get
Create a new generator
post
Get a generator
get
Update a generator
put
Delete a generator
del
List generator rows
get
Create a new generator row
post
Create multiple generator rows
post
Get a generator row
get
Update a generator row
put
Delete a generator row
del
on_premise_crowd
List On-Prem Crowd testers
get
Create an On-Prem Crowd tester
post
Delete an On-Prem Crowd tester
del
runs
List runs
get
Create a new run
post
Get historical credit usage for runs
get
Get a run
get
Update a run
put
Cancel a run
del
Get a run's JUnit XML
get
List usages for a run
get
Create a rerun
post
Create a rerun
post
List tests for a run
get
Mark tests as viewed
post
Get a test from a run
get
List comments for a run test
get
Get a step from a run
get
run_groups
List run groups
get
Create a new run group
post
Get a run group
get
Update a run group
put
Delete a run group
del
Get runs for a run group
get
Create a new run group run
post
Get run group elements
get
Add an element to a run group
post
Add multiple elements to a run group
post
Remove multiple elements from a run group
del
Get an element from a run group
get
Remove an element from a run group
del
sites
List sites
get
Create a new site
post
Get a site
get
Update a site
put
Delete a site
del
site_environments
List sites and environments
get
Update a site-environment
put
tags
List tags
get
Rename a tag
put
Delete a tag
del
tests
Get a test version
get
List tests
get
Create a new test
post
Update multiple tests
put
Delete multiple tests
del
Duplicate multiple tests
post
Regenerate a test with AI from a new prompt
put
Tag a group of tests
post
Remove tags from a group of tests
del
List credit costs for a selection of tests
get
Get a test
get
Update a test
put
Delete a test
del
Comment history for a test
get
Run history for a test
get
Run and generation history for a test
get
Get files for a test
get
Create a new file for a test
post
Get list of run group elements directly or indirectly linked to the test
get
test_results
List test results
get
users
List users
get
List all users with and without permissions
get
Invite a user to authenticated account
post
Update user permissisons
put
Reset the password for an email
post
Get a user's account information
get
Update a user
put
Delete a user account
del
Rotate a user's API token
put
Delete a user's Omniauth provider profile
del
vm_stack
List IP addresses testers come from
get
Endpoints
callback
clients
credit_cards
environments
features
folders
generators
on_premise_crowd
runs
run_groups
sites
site_environments
tags
tests
test_results
users
vm_stack
Powered byĀ
The Rainforest API
Ask AI
