Learn about our new features recently updated daily.

Learn More

Create an application

Used to create a new application.

API

POST https://api.beaglesecurity.com/rest/v2/applications

Required scope: edit_project

Request headers

Content-Type: application/json

Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Request body

name

string

required

Name of the application

url

string

required

URL of the applicaton

projectKey

string

required

A unique key for identifying the project

type

string

Used to specify wheather it's WEB or API. If left blank,default will be set to web.
Possible values are:

WEB Current application is a WEB.
APICurrent appliation is a API

Response

name

string

Name of the application

url

string

URL of the application

applicationToken

string

A unique token for identifying the application in your account

projectKey

string

A unique key for identifying the project

signatureStatus

string

Used to know the domain verification status of the application.
Possible values are:

VerifiedApplication is verified.
NotVerifiedApplication is not verified.

hostingType

string

Used to specific whether it's WEB or API. If left blank, default will be set to WEB.
Possible values are:

WEB Current application is a WEB.
APICurrent appliation is a API

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

Retrieve application details easily using the Get an Application Using Application Token API. This allows you to fetch relevant information using application token from your Beagle Security account. can update its details as needed.

Last modified: 2025/03/10

Example request

cURL

Java

                    
curl --location --request POST \
'https://api.beaglesecurity.com/rest/v2/applications' \
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Default application",
"url": "https://example.com",
"projectKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "WEB"
                    }'

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

// Create application
String applicationName = "Default application";
String url = "https://example.com";
UUID projectKey = UUID.fromString("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
ApplicationType  applicationType =  ApplicationType.WEB;
Application application = client.createApplication(applicationName, url, projectKey, applicationType);

Response

201 400 401


{
"name": "Default application",
"url": "https://example.com",
"applicationToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"projectKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"signatureStatus": "NotVerified",
"hostingType": "WEB",
"code": "SUCCESS",
"message": "Success."
}

                    {
"code": "URL_ALREADY_ADDED",
"message": "Given url is already added as an application."
}

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

Next