Modify Data

API
Description

POST /api/startTest

Start a new test run on the selected API collections or endpoints.

POST /api/stopTest

Stop an ongoing test run before it completes.

/api/stopTest

post
Header parameters
x-api-keystringRequired

You can get this from Settings > Integrations > Akto APls > Generate token

Example: API_KEY
Body
testingRunHexIdstringRequiredExample: 68b841d0828b657eb835f30c
Responses
200

description

application/json
post
/api/stopTest
200

description

/api/startTest

post
Header parameters
x-api-keystringRequired

You can get this from Settings > Integrations > Akto APls > Generate token

Example: API_KEY
Body
autoTicketingDetailsstringRequiredExample: null
continuousTestingbooleanRequiredExample: false
sendMsTeamsAlertbooleanRequiredExample: false
selectedTestsstring[]RequiredExample: ID_WRAP_ARRAY_OF_PARAMS_JSON_BODY_INTEGER_VAL
sourcestringRequiredExample: TESTING_UI
maxConcurrentRequestsinteger · int32RequiredExample: -1
typestringRequiredExample: CUSTOM
cleanUpTestingResourcesbooleanRequiredExample: false
recurringDailybooleanRequiredExample: false
overriddenTestAppUrlstringRequired
sendSlackAlertbooleanRequiredExample: false
recurringWeeklybooleanRequiredExample: false
testRunTimeinteger · int32RequiredExample: -1
startTimestampinteger · int32RequiredExample: 1756905566
recurringMonthlybooleanRequiredExample: false
testRoleIdstringRequired
testNamestringRequiredExample: juice_shop_demo_BFLA_BOLA_NO_AUTH
Responses
200

description

application/json
post
/api/startTest
200

description

Last updated

Was this helpful?