Tests

Trigger a test run

View as Markdown

Trigger a saved dashboard test remotely using API-key authentication. Returns the queued run ID.

Authentication

AuthorizationBearer
API key authentication using Bearer token format

Path parameters

testIdstringRequiredformat: "uuid"
Test ID

Request

This endpoint expects an object.
modeenumOptional
Allowed values:
platformenumOptional
Allowed values:
appIdstringOptionalformat: "uuid"
projectEnvironmentIdstringOptionalformat: "uuid"

Response

Test run queued successfully
statusenum
runIdstringformat: "uuid"
testIdstringformat: "uuid"

Errors

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error
500
Internal Server Error
504
Gateway Timeout Error