Learn about our new features recently updated daily.

Learn More

Stop a Test

Used to stop a test.

API

POST https://api.beaglesecurity.com/rest/v2/test/stop

Required scope: run_test

Request headers

Content-Type: application/json

Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Request body

applicationToken

string

required

A unique token for identifying the application in your account

Response

code

string

Status code for the API call.

Values are:

SUCCESSAPI call is success
PLAN_NOT_SUPPORTEDYour plan does not support this feature.
INVALID_SESSIONInvalid session
FAILEDFailed to stop test.
NOT_AUTHORIZEDUser authentication failed.

message

string

Success/failure message for the API call

Once a test is completed, retrieve its findings in a structured format using the Get Test Result in JSON Format API.

Last modified: 2025/03/10

Example request

cURL

Java

                    curl --location --request POST \
'https://api.beaglesecurity.com/rest/v2/test/stop' \
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
"applicationToken": "3frv64jxnaa89okc20jfyys1n8dwhgnx"
}'

                    // This token will be generated from Beagle security settings -> Access token
BeagleSecurityClient client = BeagleSecurityClientBuilder.instance()
.withAPIToken("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
.build();

// Stop a test
String applicationToken = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
Boolean testStatus = client.stopTest(applicationToken);

Response

200 400 401

                    {
"code": "SUCCESS",
"message": "Stop request has been sent successfully ."
}

                    {
"code": "FAILED",
"message": "Stop test failed."
}

                    {
"code": "NOT_AUTHORIZED",
"message": "Not authorized"
}

Next