Skip to content

Create Project

Request

Creates a project for the given input, updates project custom field values and returns projectId with success message.

Security
bearerAuth
Bodyapplication/jsonrequired

To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them. Note: For 'folderName', passing entire folder path like 'folder1/folder2' is not supported.

namestringrequired

name

Example:"eportal"
descriptionstring

description

Example:"description"
folderNamestring

folderName

Example:"Projects"
policyProfileNamestring

policyProfileName

Example:"Default License Policy Profile"
scanProfileNamestring

scanProfileName

Example:"Basic Scan Profile (Without CL)"
autoPublishboolean

autoPublish

Example:true
markAssociatedFilesAsReviewedboolean

markAssociatedFilesAsReviewed

Example:true
ownerstring

owner

Example:"admin"
riskstringHIGH|MEDIUM|LOW

risk

Enum:"HIGH""MEDIUM""LOW"
Example:"HIGH | default: MEDIUM"
privateProjectboolean

privateProject

Example:false
scanServerAliasstring

scanServerAlias

Example:"null"
deleteEmptyInventoryboolean

deleteEmptyInventory

Example:false
doNotPublishInventoryUnknownLicenseboolean

doNotPublishInventoryUnknownLicense

Example:true
folderIdinteger, (int32)
Example:1
expandJarArchivesboolean

expandJarArchives

Example:false
eccnstring, [ 0 .. 256 ] characters

eccn

Example:"5D002"
customFieldsArray of objects(CustomFieldModel)

customFields

curl -i -X POST \
  https://codeinsightapi.redocly.app/_mock/swagger/projects \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "eportal",
    "description": "description",
    "folderName": "Projects",
    "policyProfileName": "Default License Policy Profile",
    "scanProfileName": "Basic Scan Profile (Without CL)",
    "autoPublish": true,
    "markAssociatedFilesAsReviewed": true,
    "owner": "admin",
    "risk": "HIGH | default: MEDIUM",
    "privateProject": false,
    "scanServerAlias": "null",
    "deleteEmptyInventory": false,
    "doNotPublishInventoryUnknownLicense": true,
    "folderId": 1,
    "expandJarArchives": false,
    "eccn": "5D002",
    "customFields": [
      {
        "id": 1,
        "value": "Value for custom field"
      }
    ]
  }'

Responses

Created