Learn about our new features recently updated daily.

Learn More

Create a project

Used to create a new project.

API

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

Required scope: edit_project

Request headers

Content-Type: application/json

Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Request body

name

string

required

Name of the project

description

string

required

Description of the project

Response

name

string

Name of the project

description

string

Description of the project

projectKey

string

A unique key for identifying the project

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

Now that you have created a new project, you 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/projects' \
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Default project",
"description": "This is a default project."
}'

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

// create a project
String projectName = "Default project";
String description = "This is a default project";
Project project = client.createProject(projectName, description);

Response

201 400 401

        {
"name": "Default project",
"description": "This is a default project.",
"projectKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"code": "SUCCESS",
"message": "Success."
}

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

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

Next