Delete Test Run

Delete a test run and its associated resources

DELETE /api/trpc/test-runs.delete

Delete Test Run

cURL

curl --request DELETE \
  --url https://api.example.com/api/trpc/test-runs.delete

200

{
  "success": true,
  "deleted_at": "<string>",
  "deleted_resources": {
    "screenshots": 123,
    "videos": 123,
    "logs": 123
  },
  "404 Not Found": {},
  "401 Unauthorized": {},
  "409 Conflict": {}
}

Path Parameters

test_run_id · string · required

The unique identifier of the test run to delete

Query Parameters

batch · number · required

Must be set to 1

input · object · required

Show properties

test_run_id · string · required

The unique identifier of the test run to delete

delete_artifacts · boolean

If true, also delete associated artifacts (screenshots, videos). Default: false

Response

success · boolean

Indicates if the deletion was successful

deleted_at · string

ISO 8601 timestamp of when the test run was deleted

deleted_resources · object

Show properties

screenshots · integer

Number of screenshots deleted

videos · integer

Number of videos deleted

logs · integer

Number of log files deleted

Example Request

curl -X DELETE "https://api.tryiris.dev/api/trpc/test-runs.delete?batch=1&input=%7B%22test_run_id%22%3A%22run_2f3e4d5c6b%22%2C%22delete_artifacts%22%3Atrue%7D" \
  -H "Authorization: Bearer ${API_KEY}"

Example Response

{
  "success": true,
  "deleted_at": "2024-01-20T15:00:00Z",
  "deleted_resources": {
    "screenshots": 2,
    "videos": 1,
    "logs": 1
  }
}

Error Responses

404 Not Found · object

Test run not found

{
  "error": "not_found",
  "message": "Test run not found"
}

401 Unauthorized · object

Missing or invalid API key

{
  "error": "unauthorized",
  "message": "Invalid API key provided"
}

409 Conflict · object

Test run is currently active

{
  "error": "conflict",
  "message": "Cannot delete an active test run"
}