Test Suite Runs

Create

Beta
POST
Trigger a Test Suite and create a new Test Suite Run

Request

This endpoint expects an object.
test_suite_id
stringRequired
The ID of the Test Suite to run
exec_config
unionRequired
Configuration that defines how the Test Suite should be run

Response

This endpoint returns an object
id
string
created
datetime
test_suite
object
state
enum

The current state of this run

  • QUEUED - Queued
  • RUNNING - Running
  • COMPLETE - Complete
  • FAILED - Failed
  • CANCELLED - Cancelled
Allowed values: QUEUEDRUNNINGCOMPLETEFAILEDCANCELLED
exec_config
unionOptional
Configuration that defines how the Test Suite should be run
POST
$curl -X POST https://api.vellum.ai/v1/test-suite-runs \
> -H "X_API_KEY: <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{
> "test_suite_id": "string",
> "exec_config": {
> "type": "DEPLOYMENT_RELEASE_TAG",
> "data": {
> "deployment_id": "string"
> }
> }
>}'
Response
1{
2 "id": "string",
3 "created": "2023-01-01T00:00:00Z",
4 "test_suite": {
5 "id": "string",
6 "history_item_id": "string",
7 "label": "string"
8 },
9 "state": "QUEUED",
10 "exec_config": {
11 "type": "DEPLOYMENT_RELEASE_TAG",
12 "data": {
13 "deployment_id": "string",
14 "tag": "string"
15 },
16 "test_case_ids": [
17 "string"
18 ]
19 }
20}