Testkube Control Plane ../executions operations

• getGet recent executions
• getGet artifact archive
• getGet artifact
• getDownload artifact
• getGet Testkube Pro logs for execution
• getGet Testkube Pro metadata for execution
• getServe artifact

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 recent executions

Get recent executions

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment

query Parameters

kind	string The test definition's kind, either 'test', 'suite' or 'workflow'.
page	integer The desired page for this list, or the first page when absent.
pageSize	integer The desired page size for this list, or a default page size when absent.

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/organizations/{id}/environments/{environmentID}/executions

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/organizations/{id}/environments/{environmentID}/executions

Response samples

• 200
• 401
• 403

Content type

application/json

{

• "count": 0,
• "elements": [

  • {

    • "id": "string",
    • "name": "string",
    • "kind": "string",
    • "parent": "string",
    • "status": "string",
    • "duration": 0,
    • "runAt": "2019-08-24T14:15:22Z"

    }

  ]

}

Get artifact archive

Get artifact archive

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment
executionID required	string unique id of the test execution

query Parameters

testName	string name of the test
testSuiteName	string name of the testsuite

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/organizations/{id}/environments/{environmentID}/executions/{executionID}/artifact-archive

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/organizations/{id}/environments/{environmentID}/executions/{executionID}/artifact-archive

Response samples

• 200
• 400
• 401
• 403
• 404

Content type

application/json

{

• "url": "string"

}

Get artifact

Get artifact

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment
executionID required	string unique id of the test execution
artifactID required	string unique id of the artifact

query Parameters

testName	string name of the test
testSuiteName	string name of the testsuite

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/organizations/{id}/environments/{environmentID}/executions/{executionID}/artifacts/{artifactID}

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/organizations/{id}/environments/{environmentID}/executions/{executionID}/artifacts/{artifactID}

Response samples

• 200
• 400
• 401
• 403
• 404

Content type

application/json

{

• "url": "string"

}

Download artifact

Download artifact

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment
executionID required	string unique id of the test execution
artifactID required	string unique id of the artifact

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/organizations/{id}/environments/{environmentID}/executions/{executionID}/download-artifact/{artifactID}

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/organizations/{id}/environments/{environmentID}/executions/{executionID}/download-artifact/{artifactID}

Response samples

• 400
• 401
• 403
• 404
• 500

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 Testkube Pro logs for execution

Get Logs separately from execution

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment
executionID required	string unique id of the test execution

query Parameters

from required	integer line number from which logs should be returned
to required	integer line number to which logs should be returned

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/organizations/{id}/environments/{environmentID}/executions/{executionID}/logs

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/organizations/{id}/environments/{environmentID}/executions/{executionID}/logs

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

{

• "elements": [

  • {

    • "lineNumber": 123,
    • "severity": "INFO",
    • "line": "This is a log line",
    • "timestamp": "2006-01-02T15:04:05Z"

    }

  ],
• "stats": {

  • "lines": 123,
  • "bytes": 123456

  }

}

Get Testkube Pro metadata for execution

OpenAI analysis websockets stream

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment
executionID required	string unique id of the test execution

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/organizations/{id}/environments/{environmentID}/executions/{executionID}/metadata

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/organizations/{id}/environments/{environmentID}/executions/{executionID}/metadata

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

{

• "aiAnalysisResponse": "string"

}

Serve artifact

Serve artifact

Authorizations:

None

path Parameters

id required	string unique id of the object
environmentID required	string unique id of the environment
executionID required	string unique id of the test execution
artifactID required	string unique id of the artifact

query Parameters

testName	string name of the test
testSuiteName	string name of the testsuite

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/organizations/{id}/environments/{environmentID}/executions/{executionID}/serve-artifact/{artifactID}

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/organizations/{id}/environments/{environmentID}/executions/{executionID}/serve-artifact/{artifactID}

Response samples

• 200
• 400
• 401
• 403
• 404

Content type

application/json

{

• "url": "string"

}