Dependency-Track unofficial
POST/v1/project

Update a project

Updates an existing project, including its metadata, access teams, and parent relationship. Supply name and uuid in the body; set parent to an object containing the new parent’s uuid, or omit it or set it to null to remove the parent. You need PORTFOLIO_MANAGEMENT or PORTFOLIO_MANAGEMENT_UPDATE permission.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

33 body fields

Project fields to update. When you supply a body, include name and uuid; use parent to change or remove the parent.

accessTeamsarray<object>optional
Teams granted access to the project.
activebooleanoptional
Whether the project is active.
authorstringoptional
The project's author.
authorsarray<object>optional
People associated with the project, with optional email, name, and phone details.
bomRefstringoptional
The project's BOM reference.
childrenarray<object>optional
Child projects associated with this project.
classifierstringoptional
The project classifier, such as APPLICATION, FRAMEWORK, LIBRARY, CONTAINER, OPERATING_SYSTEM, DEVICE, FIRMWARE, FILE, PLATFORM, DEVICE_DRIVER, MACHINE_LEARNING_MODEL, or DATA.
Allowed:APPLICATIONFRAMEWORKLIBRARYCONTAINEROPERATING_SYSTEMDEVICEFIRMWAREFILEPLATFORMDEVICE_DRIVERMACHINE_LEARNING_MODELDATA
collectionLogicstringoptional
The collection aggregation mode: AGGREGATE_DIRECT_CHILDREN, AGGREGATE_DIRECT_CHILDREN_WITH_TAG, or AGGREGATE_LATEST_VERSION_CHILDREN.
Allowed:AGGREGATE_DIRECT_CHILDRENAGGREGATE_DIRECT_CHILDREN_WITH_TAGAGGREGATE_LATEST_VERSION_CHILDREN
collectionTagobjectoptional
The tag used to select projects for a collection; provide its `name`.
cpestringoptional
The project's CPE identifier.
descriptionstringoptional
A description of the project.
directDependenciesstringoptional
Direct dependency data for the project.
externalReferencesarray<object>optional
External references for the project, each with a URL and optional type or comment.
groupstringoptional
The group associated with the project.
inactiveSinceintegeroptional
UNIX epoch timestamp in milliseconds
isLatestbooleanoptional
lastBomImportintegerrequired
UNIX epoch timestamp in milliseconds
lastBomImportFormatstringoptional
lastInheritedRiskScorenumberoptional
lastVulnerabilityAnalysisintegeroptional
UNIX epoch timestamp in milliseconds
manufacturerobjectoptional
metadataobjectoptional
metricsobjectoptional
namestringrequired
parentobjectoptional
Recursive reference to the enclosing definition.
publisherstringoptional
purlstringoptional
supplierobjectoptional
swidTagIdstringoptional
tagsarray<object>optional
uuidstringrequired
versionstringoptional
versionsarray<object>optional

6 status codes
200Returns the updated project object.
accessTeamsarray<object>optional
activebooleanoptional
authorstringoptional
authorsarray<object>optional
bomRefstringoptional
childrenarray<object>optional
classifierstringoptional
Allowed:APPLICATIONFRAMEWORKLIBRARYCONTAINEROPERATING_SYSTEMDEVICEFIRMWAREFILEPLATFORMDEVICE_DRIVERMACHINE_LEARNING_MODELDATA
collectionLogicstringoptional
Allowed:AGGREGATE_DIRECT_CHILDRENAGGREGATE_DIRECT_CHILDREN_WITH_TAGAGGREGATE_LATEST_VERSION_CHILDREN
collectionTagobjectoptional
cpestringoptional
descriptionstringoptional
directDependenciesstringoptional
externalReferencesarray<object>optional
groupstringoptional
inactiveSinceintegeroptional
UNIX epoch timestamp in milliseconds
isLatestbooleanoptional
lastBomImportintegerrequired
UNIX epoch timestamp in milliseconds
lastBomImportFormatstringoptional
lastInheritedRiskScorenumberoptional
lastVulnerabilityAnalysisintegeroptional
UNIX epoch timestamp in milliseconds
manufacturerobjectoptional
metadataobjectoptional
metricsobjectoptional
namestringrequired
parentobjectoptional
Recursive reference to the enclosing definition.
publisherstringoptional
purlstringoptional
supplierobjectoptional
swidTagIdstringoptional
tagsarray<object>optional
uuidstringrequired
versionstringoptional
versionsarray<object>optional
400Returned when the request is invalid, including when `parent` lacks a non-null `uuid`.
401Returned when the request is unauthorized.
403Returned when you lack the required permission or access to the project, provided parent, or previous latest project version.
detailstringrequired
Human-readable explanation specific to this occurrence of the problem
instancestringoptional
Reference URI that identifies the specific occurrence of the problem
statusintegerrequired
HTTP status code generated by the origin server for this occurrence of the problem
titlestringrequired
Short, human-readable summary of the problem type
typestringoptional
A URI reference that identifies the problem type
404Returned when the UUID of the project cannot be found.
409Returned when an inactive parent is selected, active children prevent project deactivation, the specified name already exists, or the project is selected as its own parent.

Error handling

A 400 is returned when the request is invalid, including when parent is supplied without a non-null uuid. A 401 is returned when the request is unauthorized, and a 403 when you lack the required permission or access to the project, parent, or previous latest project version. A 404 is returned when the project uuid is not found; a 409 is returned when the parent is inactive, active children prevent deactivation, the name already exists, or the project is set as its own parent. When you supply a body, name and uuid are required; name must be 1–255 characters and uuid must be a UUID.