Dependency-Track unofficial
PUT/v1/service/project/{uuid}

Create a service

Creates a new service for the project identified by uuid. When you provide a service object, include name, project, and uuid; you need PORTFOLIO_MANAGEMENT or PORTFOLIO_MANAGEMENT_CREATE permission. A successful response returns the created service object.

1 parameter · 18 body fields
uuidstringrequired
The UUID of the project to create the service in.

Service data to create. When provided, the object must include name, project, and uuid.

authenticatedbooleanoptional
Whether the service is marked as authenticated.
bomRefstringoptional
The service's BOM reference.
childrenarray<object>optional
Child service records.
crossesTrustBoundarybooleanoptional
Whether the service crosses a trust boundary.
dataarray<object>optional
Data-flow entries associated with the service. Each `direction` must be INBOUND, OUTBOUND, BI_DIRECTIONAL, or UNKNOWN.
descriptionstringoptional
A service description of up to 1024 characters.
endpointsarray<string>optional
Endpoint strings associated with the service.
externalReferencesarray<object>optional
External references associated with the service. Each entry must include a non-empty `url`.
groupstringoptional
The service group, up to 255 characters.
lastInheritedRiskScorenumberoptional
The most recently inherited risk score, as a double-precision number.
namestringrequired
The service name, from 1 to 255 characters.
notesstringoptional
Notes associated with the service.
parentobjectoptional
Recursive reference to the enclosing definition.
projectobjectrequired
The project associated with the service.
providerobjectoptional
Provider information for the service.
uuidstringrequired
The service's unique identifier.
versionstringoptional
vulnerabilitiesarray<object>optional

4 status codes
201Returns the created service object.
authenticatedbooleanoptional
bomRefstringoptional
childrenarray<object>optional
crossesTrustBoundarybooleanoptional
dataarray<object>optional
descriptionstringoptional
endpointsarray<string>optional
externalReferencesarray<object>optional
groupstringoptional
lastInheritedRiskScorenumberoptional
namestringrequired
notesstringoptional
parentobjectoptional
Recursive reference to the enclosing definition.
projectobjectrequired
providerobjectoptional
uuidstringrequired
versionstringoptional
vulnerabilitiesarray<object>optional
401Returned when the request is unauthenticated.
403Returned when access to the requested project is forbidden.
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 project cannot be found.

Error handling

A 401 is returned when you are unauthenticated, a 403 when you lack the required permission or access to the project, and a 404 when the project identified by the uuid path parameter cannot be found. When you supply a service object, include name, project, and uuid; name must be 1 to 255 characters, description at most 1024 characters, and group at most 255 characters. Each externalReferences entry must include a non-empty url, and data.direction must be INBOUND, OUTBOUND, BI_DIRECTIONAL, or UNKNOWN.