Testkube Control Plane ../test-suite-executions operations

• getGet all test suite executions
• postStarts new test suite executions
• getGet test suite execution by ID
• patchAborts testsuite execution
• getGet test suite execution artifacts

API docs by Redocly

Testkube Pro API (cloud-api/1.10.51)

Download OpenAPI specification:Download

E-mail: testkube@kubeshop.io License: COMMERICAL

API for Testkube Pro

Get all test suite executions

Returns array of test suite executions

path Parameters

id required	string organizationId
environmentId required	string environmentID
testName required	string unique id of the test

query Parameters

last	integer Default: 7 last N days to show
textSearch	string Default: "" text to search in name and test name
pageSize	integer The desired page size for this list, or a default page size when absent.
page	integer Default: 0 the page index to start at
status	string (TestSuiteExecutionStatus) Enum: "queued" "running" "passed" "failed" "aborting" "aborted" "timeout" optional status filter containing multiple values separated by comma
startDate	string <date> startDate for filtering in ISO-8601 format, i.e. "yyyy-mm-dd"
endDate	string <date> endDate for filtering
selector	string Example: selector=kubernetes.io/app=demo Only workflow executions with given status are included in this time series chart.

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/test-suite-executions

Response samples

• 200
• 500

Content type

application/json

{

• "totals": {

  • "results": 0,
  • "passed": 0,
  • "failed": 0,
  • "queued": 0,
  • "running": 0

  },
• "filtered": {

  • "results": 0,
  • "passed": 0,
  • "failed": 0,
  • "queued": 0,
  • "running": 0

  },
• "results": [

  • {

    • "id": "62f395e004109209b50edfc1",
    • "name": "test-suite1.needlessly-sweet-imp",
    • "testSuiteName": "test-suite1",
    • "status": "queued",
    • "startTime": "2019-08-24T14:15:22Z",
    • "endTime": "2019-08-24T14:15:22Z",
    • "duration": "00:00:09",
    • "durationMs": 9009,
    • "execution": [

      • {

        • "execute": [

          • {

            • "id": "62f395e004109209b50edfc4",
            • "name": "run:testkube/test1",
            • "testName": "test1",
            • "status": "queued",
            • "type": "executeTest"

            }

          ]

        }

      ],
    • "labels": {

      • "app": "backend",
      • "env": "prod"

      }

    }

  ]

}

Starts new test suite executions

New test suite executions returns new executions details on successful executions start

path Parameters

id required	string organizationId
environmentId required	string environmentID

query Parameters

namespace	string Default: "testkube" Namespace of the object
selector	string Example: selector=kubernetes.io/app=demo Only workflow executions with given status are included in this time series chart.
concurrency	integer Default: 10

Request Body schema: application/json

required

body passed to configure executions

name	string test execution custom name
number	integer test suite execution number
namespace	string test kubernetes namespace ("testkube" when not set)
	object (Variables) execution variables passed to executor converted to vars for usage in tests
secretUUID	string secret uuid
	object test suite labels
	object execution labels
sync	boolean whether to start execution sync or async
httpProxy	string http proxy for executor containers
httpsProxy	string https proxy for executor containers
timeout	integer <int32> duration in seconds the test suite may be active, until its stopped
	object (TestContentRequest) test content request body
	object (RunningContext) running context for test or test suite execution
jobTemplate	string job template extensions
jobTemplateReference	string name of the template resource
cronJobTemplate	string cron job template extensions
cronJobTemplateReference	string name of the template resource
scraperTemplate	string scraper template extensions
scraperTemplateReference	string name of the template resource
pvcTemplate	string pvc template extensions
pvcTemplateReference	string name of the template resource
concurrencyLevel	integer <int32> number of tests run in parallel
testSuiteExecutionName	string test suite execution name started the test suite execution
disableWebhooks	boolean Default: false whether webhooks on the execution of this test suite are disabled

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/test-suite-executions

Request samples

• Payload

Content type

application/json

{

• "name": "testing with 1000 users",
• "number": 1,
• "namespace": "testkube",
• "variables": {

  • "secret1": {

    • "name": "secret1",
    • "type": "secret",
    • "value": "secretvalue1"

    },
  • "var1": {

    • "name": "var1",
    • "type": "basic",
    • "value": "value1"

    }

  },
• "secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
• "labels": {

  • "prefix": "some-",
  • "users": "3"

  },
• "executionLabels": {

  • "prefix": "some-",
  • "users": "3"

  },
• "sync": true,
• "httpProxy": "user:pass@my.proxy.server:8080",
• "httpsProxy": "user:pass@my.proxy.server:8081",
• "timeout": 1,
• "contentRequest": {

  • "repository": {

    • "branch": "main",
    • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
    • "path": "test/perf",
    • "workingDir": "/"

    }

  },
• "runningContext": {

  • "type": "userCLI",
  • "context": "string"

  },
• "jobTemplate": "string",
• "jobTemplateReference": "string",
• "cronJobTemplate": "string",
• "cronJobTemplateReference": "string",
• "scraperTemplate": "string",
• "scraperTemplateReference": "string",
• "pvcTemplate": "string",
• "pvcTemplateReference": "string",
• "concurrencyLevel": 10,
• "testSuiteExecutionName": "string",
• "disableWebhooks": [

  • true,
  • false

  ]

}

Response samples

• 201
• 400
• 500
• 502

Content type

application/json

[

• {

  • "totals": {

    • "results": 0,
    • "passed": 0,
    • "failed": 0,
    • "queued": 0,
    • "running": 0

    },
  • "filtered": {

    • "results": 0,
    • "passed": 0,
    • "failed": 0,
    • "queued": 0,
    • "running": 0

    },
  • "results": [

    • {

      • "id": "62f395e004109209b50edfc1",
      • "name": "test-suite1.needlessly-sweet-imp",
      • "testSuiteName": "test-suite1",
      • "status": "queued",
      • "startTime": "2019-08-24T14:15:22Z",
      • "endTime": "2019-08-24T14:15:22Z",
      • "duration": "00:00:09",
      • "durationMs": 9009,
      • "execution": [

        • {

          • "execute": [

            • {

              • "id": "62f395e004109209b50edfc4",
              • "name": "run:testkube/test1",
              • "testName": "test1",
              • "status": "queued",
              • "type": "executeTest"

              }

            ]

          }

        ],
      • "labels": {

        • "app": "backend",
        • "env": "prod"

        }

      }

    ]

  }

]

Get test suite execution by ID

Returns test suite execution with given executionID

path Parameters

id required	string organizationId
environmentId required	string environmentID
executionID required	string unique id of the object execution

query Parameters

last	integer Default: 7 last N days to show

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/test-suite-executions/{executionID}

Response samples

• 200
• 500

Content type

application/json

{

• "id": "62f395e004109209b50edfc1",
• "name": "test-suite1.needlessly-sweet-imp",
• "testSuite": {

  • "namespace": "testkube",
  • "name": "name"

  },
• "status": "queued",
• "envs": {

  • "prefix": "some-",
  • "record": "true"

  },
• "variables": {

  • "secret1": {

    • "name": "secret1",
    • "type": "secret",
    • "value": "secretvalue1"

    },
  • "var1": {

    • "name": "var1",
    • "type": "basic",
    • "value": "value1"

    }

  },
• "secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
• "startTime": "2019-08-24T14:15:22Z",
• "endTime": "2019-08-24T14:15:22Z",
• "duration": "2m",
• "durationMs": 6000,
• "stepResults": [

  • {

    • "step": {

      • "stopTestOnFailure": true,
      • "execute": {

        • "namespace": "testkube",
        • "name": "name"

        },
      • "delay": {

        • "duration": 0

        }

      },
    • "test": {

      • "namespace": "testkube",
      • "name": "name"

      },
    • "execution": {

      • "id": "62f395e004109209b50edfc4",
      • "testName": "example-test",
      • "testSuiteName": "test-suite1",
      • "testNamespace": "testkube",
      • "testType": "postman/collection",
      • "name": "test-suite1-example-test-1",
      • "number": 1,
      • "envs": {

        • "prefix": "some-",
        • "record": "true"

        },
      • "command": [

        • "curl"

        ],
      • "args": [

        • "--concurrency",
        • "2",
        • "--remote",
        • "--some",
        • "blabla"

        ],
      • "args_mode": "append",
      • "variables": {

        • "secret1": {

          • "name": "secret1",
          • "type": "secret",
          • "value": "secretvalue1"

          },
        • "var1": {

          • "name": "var1",
          • "type": "basic",
          • "value": "value1"

          }

        },
      • "isVariablesFileUploaded": false,
      • "variablesFile": "string",
      • "testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
      • "testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
      • "content": {

        • "type": "string",
        • "repository": {

          • "type": "git",
          • "uri": "https://github.com/kubeshop/testkube",
          • "branch": "main",
          • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
          • "path": "test/perf",
          • "username": "string",
          • "token": "string",
          • "usernameSecret": {

            • "namespace": "string",
            • "name": "string",
            • "key": "string"

            },
          • "tokenSecret": {

            • "namespace": "string",
            • "name": "string",
            • "key": "string"

            },
          • "certificateSecret": "string",
          • "workingDir": "/",
          • "authType": "basic"

          },
        • "data": "string",
        • "uri": "https://github.com/kubeshop/testkube"

        },
      • "startTime": "2019-08-24T14:15:22Z",
      • "endTime": "2019-08-24T14:15:22Z",
      • "duration": "88s",
      • "durationMs": 10000,
      • "executionResult": {

        • "status": "queued",
        • "output": "string",
        • "outputType": "text/plain",
        • "errorMessage": "string",
        • "steps": [

          • {

            • "name": "step1",
            • "duration": "10m0s",
            • "status": "passed",
            • "assertionResults": [

              • {

                • "name": "assertion1",
                • "status": "passed",
                • "errorMessage": "string"

                }

              ]

            }

          ],
        • "reports": {

          • "junit": "string"

          }

        },
      • "labels": {

        • "app": "backend",
        • "env": "prod"

        },
      • "uploads": [

        • "settings/config.txt"

        ],
      • "bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
      • "artifactRequest": {

        • "storageClassName": "artifact-volume-local",
        • "volumeMountPath": "string",
        • "dirs": [

          • "string"

          ],
        • "masks": [

          • "string"

          ],
        • "storageBucket": "test1-artifacts",
        • "omitFolderPerExecution": true,
        • "sharedBetweenPods": true,
        • "useDefaultStorageClassName": true,
        • "sidecarScraper": true

        },
      • "preRunScript": "echo -n '$SECRET_ENV' > ./secret_file",
      • "postRunScript": "sleep 30",
      • "executePostRunScriptBeforeScraping": true,
      • "sourceScripts": true,
      • "runningContext": {

        • "type": "userCLI",
        • "context": "string"

        },
      • "containerShell": "/bin/sh",
      • "testExecutionName": "string",
      • "downloadArtifactExecutionIDs": [

        • "string"

        ],
      • "downloadArtifactTestNames": [

        • "string"

        ],
      • "slavePodRequest": {

        • "resources": {

          • "requests": {

            • "cpu": "250m",
            • "memory": "64Mi"

            },
          • "limits": {

            • "cpu": "250m",
            • "memory": "64Mi"

            }

          },
        • "podTemplate": "string",
        • "podTemplateReference": "string"

        },
      • "executionNamespace": "string",
      • "disableWebhooks": [

        • true,
        • false

        ]

      }

    }

  ],
• "executeStepResults": [

  • {

    • "step": {

      • "stopOnFailure": true,
      • "downloadArtifacts": {

        • "allPreviousSteps": false,
        • "previousStepNumbers": [

          • 0

          ],
        • "previousTestNames": [

          • "string"

          ]

        },
      • "execute": [

        • {

          • "test": "name",
          • "delay": "1s",
          • "executionRequest": {

            • "executionLabels": {

              • "prefix": "some-",
              • "users": "3"

              },
            • "variables": {

              • "secret1": {

                • "name": "secret1",
                • "type": "secret",
                • "value": "secretvalue1"

                },
              • "var1": {

                • "name": "var1",
                • "type": "basic",
                • "value": "value1"

                }

              },
            • "command": [

              • "curl"

              ],
            • "args": [

              • "--repeats",
              • "5",
              • "--insecure"

              ],
            • "args_mode": "append",
            • "sync": true,
            • "httpProxy": "user:pass@my.proxy.server:8080",
            • "httpsProxy": "user:pass@my.proxy.server:8081",
            • "negativeTest": false,
            • "jobTemplate": "string",
            • "jobTemplateReference": "string",
            • "cronJobTemplate": "string",
            • "cronJobTemplateReference": "string",
            • "scraperTemplate": "string",
            • "scraperTemplateReference": "string",
            • "pvcTemplate": "string",
            • "pvcTemplateReference": "string",
            • "runningContext": {

              • "type": "userCLI",
              • "context": "string"

              },
            • "disableWebhooks": [

              • true,
              • false

              ]

            }

          }

        ]

      },
    • "execute": [

      • {

        • "step": {

          • "test": "name",
          • "delay": "1s",
          • "executionRequest": {

            • "executionLabels": {

              • "prefix": "some-",
              • "users": "3"

              },
            • "variables": {

              • "secret1": {

                • "name": "secret1",
                • "type": "secret",
                • "value": "secretvalue1"

                },
              • "var1": {

                • "name": "var1",
                • "type": "basic",
                • "value": "value1"

                }

              },
            • "command": [

              • "curl"

              ],
            • "args": [

              • "--repeats",
              • "5",
              • "--insecure"

              ],
            • "args_mode": "append",
            • "sync": true,
            • "httpProxy": "user:pass@my.proxy.server:8080",
            • "httpsProxy": "user:pass@my.proxy.server:8081",
            • "negativeTest": false,
            • "jobTemplate": "string",
            • "jobTemplateReference": "string",
            • "cronJobTemplate": "string",
            • "cronJobTemplateReference": "string",
            • "scraperTemplate": "string",
            • "scraperTemplateReference": "string",
            • "pvcTemplate": "string",
            • "pvcTemplateReference": "string",
            • "runningContext": {

              • "type": "userCLI",
              • "context": "string"

              },
            • "disableWebhooks": [

              • true,
              • false

              ]

            }

          },
        • "test": {

          • "namespace": "testkube",
          • "name": "name"

          },
        • "execution": {

          • "id": "62f395e004109209b50edfc4",
          • "testName": "example-test",
          • "testSuiteName": "test-suite1",
          • "testNamespace": "testkube",
          • "testType": "postman/collection",
          • "name": "test-suite1-example-test-1",
          • "number": 1,
          • "envs": {

            • "prefix": "some-",
            • "record": "true"

            },
          • "command": [

            • "curl"

            ],
          • "args": [

            • "--concurrency",
            • "2",
            • "--remote",
            • "--some",
            • "blabla"

            ],
          • "args_mode": "append",
          • "variables": {

            • "secret1": {

              • "name": "secret1",
              • "type": "secret",
              • "value": "secretvalue1"

              },
            • "var1": {

              • "name": "var1",
              • "type": "basic",
              • "value": "value1"

              }

            },
          • "isVariablesFileUploaded": false,
          • "variablesFile": "string",
          • "testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
          • "testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
          • "content": {

            • "type": "string",
            • "repository": {

              • "type": "git",
              • "uri": "https://github.com/kubeshop/testkube",
              • "branch": "main",
              • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
              • "path": "test/perf",
              • "username": "string",
              • "token": "string",
              • "usernameSecret": {

                • "namespace": "string",
                • "name": "string",
                • "key": "string"

                },
              • "tokenSecret": {

                • "namespace": "string",
                • "name": "string",
                • "key": "string"

                },
              • "certificateSecret": "string",
              • "workingDir": "/",
              • "authType": "basic"

              },
            • "data": "string",
            • "uri": "https://github.com/kubeshop/testkube"

            },
          • "startTime": "2019-08-24T14:15:22Z",
          • "endTime": "2019-08-24T14:15:22Z",
          • "duration": "88s",
          • "durationMs": 10000,
          • "executionResult": {

            • "status": "queued",
            • "output": "string",
            • "outputType": "text/plain",
            • "errorMessage": "string",
            • "steps": [

              • {

                • "name": "step1",
                • "duration": "10m0s",
                • "status": "passed",
                • "assertionResults": [

                  • null

                  ]

                }

              ],
            • "reports": {

              • "junit": "string"

              }

            },
          • "labels": {

            • "app": "backend",
            • "env": "prod"

            },
          • "uploads": [

            • "settings/config.txt"

            ],
          • "bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
          • "artifactRequest": {

            • "storageClassName": "artifact-volume-local",
            • "volumeMountPath": "string",
            • "dirs": [

              • "string"

              ],
            • "masks": [

              • "string"

              ],
            • "storageBucket": "test1-artifacts",
            • "omitFolderPerExecution": true,
            • "sharedBetweenPods": true,
            • "useDefaultStorageClassName": true,
            • "sidecarScraper": true

            },
          • "preRunScript": "echo -n '$SECRET_ENV' > ./secret_file",
          • "postRunScript": "sleep 30",
          • "executePostRunScriptBeforeScraping": true,
          • "sourceScripts": true,
          • "runningContext": {

            • "type": "userCLI",
            • "context": "string"

            },
          • "containerShell": "/bin/sh",
          • "testExecutionName": "string",
          • "downloadArtifactExecutionIDs": [

            • "string"

            ],
          • "downloadArtifactTestNames": [

            • "string"

            ],
          • "slavePodRequest": {

            • "resources": {

              • "requests": {

                • "cpu": "250m",
                • "memory": "64Mi"

                },
              • "limits": {

                • "cpu": "250m",
                • "memory": "64Mi"

                }

              },
            • "podTemplate": "string",
            • "podTemplateReference": "string"

            },
          • "executionNamespace": "string",
          • "disableWebhooks": [

            • true,
            • false

            ]

          }

        }

      ],
    • "startTime": "2019-08-24T14:15:22Z",
    • "endTime": "2019-08-24T14:15:22Z",
    • "duration": "2m"

    }

  ],
• "labels": {

  • "app": "backend",
  • "env": "prod"

  },
• "runningContext": {

  • "type": "userCLI",
  • "context": "string"

  },
• "testSuiteExecutionName": "string",
• "disableWebhooks": [

  • true,
  • false

  ]

}

Aborts testsuite execution

Aborts testsuite execution with given executionID

path Parameters

id required	string organizationId
environmentId required	string environmentID
executionID required	string unique id of the object execution

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/test-suite-executions/{executionID}

Response samples

• 502

Content type

application/problem+json

[

• {

  • "type": "https://kubeshop.io/testkube/problems/invalidtestname",
  • "title": "Invalid test name",
  • "status": 500,
  • "detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
  • "instance": "http://10.23.23.123:8088/tests"

  }

]

Get test suite execution artifacts

Returns test suite execution artifacts with given executionID

path Parameters

id required	string organizationId
environmentId required	string environmentID
executionID required	string unique id of the object execution

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/test-suite-executions/{executionID}/artifacts

Response samples

• 200
• 500

Content type

application/json

{

• "name": "string",
• "size": 0,
• "executionName": "test-1",
• "status": "ready"

}