Learn about our new features recently updated daily.

Learn More

Start a Test

Used to start a test.

API

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

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
INVALID_SESSIONInvalid session
FAILEDFailed to start test.
NOT_AUTHORIZEDUser authentication failed.

statusUrl

string

URL for getting test status

resultUrl

string

URL for getting test result

resultToken

string

A unique key for identify result session

message

string

Success/failure message for the API call

Monitor the progress of an ongoing test using the Status of a Test API, which provides real-time updates on the test status.

Last modified: 2025/03/10

Example request

cURL

Java

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

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

// Start a test
String applicationToken = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
StartTest startTestResult = client.startTest(applicationToken);

Response

200 400 401

                    {
"code": "SUCCESS",
"statusUrl": "https://api.dev.beaglesecure.com/rest/v2/test/status",
"resultUrl": "https://api.dev.beaglesecure.com/rest/v2/test/result",
"resultToken": "1ry0hrn7bt8kwiuayrul7a2ka8vp7if5",
"message": "Test has been started successfully."
}

                    {
"code": "INVALID_SESSION",
"message": "Given token is invalid"
}

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

Next