For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Discord
DocsAPI Reference
DocsAPI Reference
  • Projects
    • GETList projects
    • POSTCreate a project
    • GETGet a project
    • DELDelete a project
    • PATCHUpdate a project
    • GETList project credentials
    • POSTCreate a project credential
    • GETList project memories
    • POSTCreate a project memory
    • DELDelete a project memory
    • GETList project files
    • GETList project mobile apps
    • POSTUpload a project mobile app
    • DELDelete a project mobile app
    • POSTInitiate a project mobile app upload
    • POSTConfirm a project mobile app upload
  • Tests
    • GETList tests
    • POSTCreate a test
    • GETGet a test
    • DELDelete a test
    • PATCHUpdate a test
    • POSTTrigger a test run
  • Groups
    • GETList test groups
    • POSTCreate a test group
    • GETGet a test group
    • DELDelete a test group
    • PATCHUpdate a test group
    • POSTAdd a test to a group
    • DELRemove a test from a group
    • POSTTrigger a test group run
  • Webhooks
    • POSTTrigger a project webhook
    • POSTTrigger a group webhook
  • Test Runs
    • GETList test runs
    • GETGet test run status
    • POSTCancel a queued or running run
LogoLogo
Discord
Groups

Trigger a test group run

||View as Markdown|
POST
https://tester.army/v1/groups/:groupId/runs
POST
/v1/groups/:groupId/runs
$curl -X POST https://tester.army/v1/groups/groupId/runs \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "status": "queued",
3  "groupId": "string",
4  "batchId": "string",
5  "runIds": [
6    "string"
7  ],
8  "queuedRunIds": [
9    "string"
10  ],
11  "cancelledRunIds": [
12    "string"
13  ],
14  "count": 1,
15  "metadata": {
16    "github": {
17      "configured": true,
18      "checkRunCreated": true,
19      "commentTargetResolved": true,
20      "status": "not_configured"
21    }
22  }
23}

Trigger all runnable tests in a group using API-key authentication. Returns the batch ID plus queuedRunIds (runs accepted onto the worker) and cancelledRunIds (runs the server immediately cancelled, e.g. duplicates or quota cancellations). status is queued when at least one run is queued and cancelled when every run was rejected.

Was this page helpful?
Previous

Remove a test from a group

Next

Trigger a project webhook

Built with

Authentication

AuthorizationBearer
API key authentication using Bearer token format

Path parameters

groupIdstringRequiredformat: "uuid"
Test group ID

Request

This endpoint expects an object.
platformenumOptional
Allowed values:
targetUrlstringOptionalformat: "uri"
environmentenumOptional
Allowed values:
mobileobjectOptional
commitShastringOptional>=1 character
prNumberintegerOptional

Response

Group run queued successfully
statusenum
Allowed values:
groupIdstringformat: "uuid"
batchIdstringformat: "uuid"
runIdslist of strings
queuedRunIdslist of strings
cancelledRunIdslist of strings
countinteger
metadataobject

Errors

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