Learn about our new features recently updated daily.

Learn More

Delete a project

Used to Delete details of existing project.

API

DELETE https://api.beaglesecurity.com/rest/v2/projects?project_key={project_key}

Required scope: edit_project

Request headers

Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Request Parameter

projectKey

string

required

A unique key for identifying 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

Want to collaborate on projects with your team? The Create Project in a Team API allows you to set up a new project within your team's workspace.enabling seamless teamwork and project management.

Last modified: 2025/03/10

Example request

cURL

Java

                            curl --location --request DELETE \
'https://api.beaglesecurity.com/rest/v2/projects?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();

// Delete a project
UUID projectKey = UUID.fromString("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
Project project = client.deleteProject(projectKey);

Response

200 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