Learn about our new features recently updated daily.

Learn More

Read all applications under a project

Used to read all the applications under a project.

API

GET https://api.beaglesecurity.com/rest/v2/applications?project_key={project_key}

Required scope: read_project

Request headers

Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Request Parameter

projectKey

string

required

A unique key for identifying the project

Response

code

string

Status code for the API call.

Values are:

SUCCESSAPI call is success
PLAN_NOT_SUPPORTEDYour plan does not support this feature.
PROJECT_ALREADY_EXISTSProject already exists in your account.
INVALID_SESSIONInvalid session
FAILEDFailed to create project.
NOT_AUTHORIZEDUser authentication failed.

message

string

Success/failure message for the API call

application

object

Application object which contains details of an application

To ensure authorized security testing, domain verification is required. This section introduces Domain Verification, a process that confirms ownership or authorization for testing a domain.

Last modified: 2025/03/10

Example request

cURL

Java

                    curl --location --request GET \
                    'https://api.beaglesecurity.com/rest/v2/applications?project_key=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' \
                    --header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

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

                    // Get all applications under a project
                    UUID projectKey = UUID.fromString("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
                    List<Application> application = client.getApplications(projectKey);

Response

200 400 401

                                
{
"code": "SUCCESS",
"message": "Success",
"applications": [
{
    "name": "Example 1",
    "url": "http://196.168.0.7:80",
    "applicationToken": "3frv64jxnaa89okc20jfyys1n8dwhgnx",
    "applicationType": "WEB",
    "signatureStatus": "Verified",
    "hostingType": "internal"
},
{
    "name": "Example 2",
    "url": "http://johndoe.com",
    "applicationToken": "loa3qt7wpe21gtrwqf9joseikl9taf0y",
    "applicationType": "WEB",
    "signatureStatus": "NotVerified",
    "hostingType": "public"
},
{
    "name": "Example 3",
    "url": "https://example.com",
    "applicationToken": "qcyqpuhski5l57rfjcqwjg82mng9un1s",
    "applicationType": "WEB",
    "signatureStatus": "NotVerified",
    "hostingType": "public"
},
{
    "name": "Example 4",
    "url": "https://192.168.1.1:1234",
    "applicationToken": "4n49wavb2tc1bale4dt3sv6207v9rhtz",
    "applicationType": "API",
    "signatureStatus": "Verified",
    "hostingType": "internal"
}
]
}

                                
{
"code": "PLAN_NOT_SUPPORTED",
"message": "Your plan does not support this feature."
}

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

Next