Skip to main content
POST
Create project

Headers

X-Workspace-Id
string

Workspace ID

Body

application/json
name
string
required

Name of the project

Example:

"Web Servers"

hexColor
string

Hex color of the project

Example:

"#78716C"

description
string

What the project covers

hostIds
string[]

Asset (host) IDs picked by hand

scopeRules
object[]

Scope rules; matching assets join the project

autoAddAssets
boolean
default:true

Add assets found later when they match a rule

template
string

Workflow template (file name of a default workflow) for the pipeline. Ignored when tools are given.

Example:

"vulnerability_scan_basic.yaml"

tools
object[]

Tools of the pipeline, with optional stages

workflowName
string

Name of the pipeline

on
object

When the pipeline runs on its own: schedules and "assets added". Requires a pipeline. Replaces schedule and onAssetsAdded.

schedule
string

Deprecated, use on.schedule. Cron schedule (UTC) of the pipeline, e.g. "0 2 * * 1". Requires a pipeline.

Example:

"0 0 */3 * *"

onAssetsAdded
object

Deprecated, use on.assetsAdded. Run the pipeline on assets as they join the project. Requires a pipeline.

runNow
boolean

Start a run on the whole scope right after creation

Response

200 - application/json
id
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
name
string
required
autoAddAssets
boolean
required
totalAssets
number
required
hexColor
string
Example:

"#78716C"

description
string | null
archivedAt
string<date-time> | null
projectWorkflows
object[]
lastRunAt
string<date-time> | null