Learn about our new features recently updated daily.

Learn More

Status of a Test

Used to get the status of a running test.

API

GET https://api.beaglesecurity.com/rest/v2/test/status?application_token={applicationToken}&result_token={result_token}

Required scope: read_test_status

Request headers

Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Request parameters

application_token

string

required

A unique token for identifying the application in your account

result_token

string

required

A unique key for identify result session

Response

status

string

Status of the test
Possible values are:

runningTest is running
completedTest completed

progress

string

Percentage of test completed

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 get test status.
NOT_AUTHORIZEDUser authentication failed.

message

string

Success/failure message for the API call

Need to halt a running test? The Stop a Test API allows you to cancel an ongoing security test at any stage.

Last modified: 2025/03/10

Example request

cURL

Java

                    curl --location --request GET \
'https://api.beaglesecurity.com/rest/v2/test/status?application_token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&result_token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

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

// Get test status
String applicationToken = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
String resultToken = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
TestStatus testStatus = client.getTestStatus(applicationToken, resultToken);

Response

200 400 401

                    {
"status": "running",
"progress": 3,
"code": "SUCCESS",
"message": "Test is in progress."
}

                    {
"code": "FAILED",
"message": "Get status failed."
}

Next