v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB

Test Execution

Create Test Execution

Trigger test execution(s) for a given project.

Scope determines which fields are required:

scope=TEST — provide a tests array of test file names (each ending in .test.yaml).
scope=PIPELINE — provide a pipelines array of pipeline file names (each ending in .orch.yaml or .tran.yaml). All tests associated with those pipelines will run.
scope=PROJECT — runs every test in the project; no tests or pipelines field needed.

environmentName is always required. versionName, executionTag, and agentId are optional and work with any scope.

post/v1/projects/{projectId}/test-executions

Path parameters

projectIdstring uuid required

Request body

agentIdstring

Optional agent ID. If not specified, the default agent for the environment will be used

environmentNamestring required

The environment to execute tests in

executionTagstring

Optional tag to control execution concurrency

scope'TEST' | 'PIPELINE' | 'PROJECT' required

Execution scope: TEST, PIPELINE, or PROJECT

versionNamestring

Optional artifact version name to execute tests against

Example request

{
  "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "environmentName": "environment1",
  "executionTag": "nightly",
  "pipelines": [
    {
      "name": "mypipeline.orch.yaml"
    }
  ],
  "scope": "TEST",
  "tests": [
    {
      "name": "mytest.test.yaml"
    }
  ],
  "versionName": "v1.2.3"
}

Response

Test execution created

testExecutionIdstring

Server-generated identifier for the test execution

Example response

{
  "testExecutionId": "1398aa31-af57-4a6a-9752-27c2e8556c3f"
}