Note: Beagle Security API v1 has been deprecated. We recommend that you upgrade to v2
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
Name Value
Authorization Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Request parameter
Name Type Description Required
projectKey string A unique key for identifying the project
Example request
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> applications = client.getApplications(projectKey);
Response
Name Type Description
code string Status code for the API call.
Values are:
SUCCESS API call is success
PLAN_NOT_SUPPORTED Your plan does not support this feature.
PROJECT_ALREADY_EXISTS Project already exists in your account.
INVALID_SESSION Invalid session
FAILED Failed to read the details of all applications.
NOT_AUTHORIZED User authentication failed.
message string Success/failure message for the API call
applications object Application object which contains details of an application
Example response
{
"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"
}