API reference / Tests and incidents
Change a test
Changes a test: send only what changes. steps replaces all its steps. status active approves a proposed test, and paused stops it from running. A teammate changes only the proposed tests that it wrote, and never their status. Send the version you read to refuse the change if someone changed it since.
/api/v1/tests/{id}Other ways to call it
troopy tests updatetroopy_update_testIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Path parameters
id*stringA 24-character id
Body
application/jsontitlestringAt least 1 characters · At most 120 characters
stepsarray<object>The steps in order. Troopy numbers them s1, s2 and so on
At most 30 items
2 properties
kind*enum<string>do: an action. check: what must show. picture: a picture to take
docheckpicture
text*stringAt least 1 characters · At most 500 characters
tagsarray<string>At most 10 items
smokebooleanproductionbooleanaccountstring | nullThe label of a test account of the place where it runs, or null
statusenum<string>activepaused
versionintegerResponse
200 · application/jsondata*object13 properties
id*stringA 24-character id
title*stringsteps*array<object>3 properties
id*strings1, s2 and so on, in order
kind*enum<string>do: an action. check: what must show. picture: a picture to take
docheckpicture
text*stringtags*array<string>smoke*booleanOn the main path: it runs after each release
production*booleanSafe for Production: no step changes data
account*string | nullThe label of the test account that it signs in with. null when it signs in with none
status*enum<string>A teammate's test is proposed until a person makes it active. A paused test does not run
proposedactivepaused
createdBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringupdatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringversion*integercreatedAt*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time