Skip to main content
A test suite is a named container of tests inside one project. Create the suite before you create its first test. Empty suites and duplicate suite names are valid. A suite has a stable ste_… ID and a mutable name. It has no version and no run settings. Every test belongs to one suite for its full life.

​
Create a suite

POST /v1/test-suites
​
string
Project ID or name. Omit it when the API key already selects one project.
​
string
required
A nonblank display name. It does not need to be unique in the project.
The response is 201 Created with the new suite.
​
string
The stable suite ID (ste_…).
​
string
The project that owns the suite.
​
string
The current display name.
​
string
ISO 8601 creation time.
​
string
ISO 8601 time of the latest rename or lifecycle change.

​
List suites

GET /v1/test-suites Returns active suites in the current project as a paginated list.
​
string
Project ID or name. Omit it when the API key already selects one project.
​
string
The nextPageToken value from the previous page.
​
integer
Number of suites to return. The maximum is 200.

​
Get a suite

GET /v1/test-suites/:suiteId
​
string
required
The stable ste_… suite ID.
Returns the active suite. Use GET /v1/tests?suiteId=ste_… to page through its tests. All suite read and write operations accept an optional projectId query parameter when the credential does not already select one project.

​
Rename a suite

PATCH /v1/test-suites/:suiteId Renaming changes only the display name. The suite ID and its tests stay the same. Earlier runs show the current name through that stable ID.
​
string
required
The new nonblank display name.

​
Delete a suite

DELETE /v1/test-suites/:suiteId This permanently removes the suite and every test inside it from authoring and future runs. There is no Restore action. Completed runs remain readable and show the suite’s last name with (deleted).
Deleting a suite also deletes every test inside it. Confirm the suite and its tests before you send this request.