Dependency-Track unofficial
POST/v1/configProperty/aggregate

Update configuration properties

Updates multiple configuration properties from an array of property entries. The authenticated user must have SYSTEM_CONFIGURATION or SYSTEM_CONFIGURATION_UPDATE permission, and each entry must include groupName and propertyName. The response reports the result for each entry, including an error message when a property cannot be updated.

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

3 body fields

An array of configuration property entries. Each entry must include groupName and propertyName; propertyValue is optional.

groupNamestringrequired
Group the property belongs to
propertyNamestringrequired
Name of the property
propertyValuestringoptional
Value of the property

2 status codes
200Returns an array containing either the updated configuration property or an error message for each entry that could not be updated because the property was not found, is read-only, or has an invalid value.
descriptionstringoptional
Description of the property
groupNamestringrequired
Group the property belongs to
propertyNamestringrequired
Name of the property
propertyTypestringrequired
Type of the property
Allowed:BOOLEANINTEGERNUMBERSTRINGTIMESTAMPURLUUID
propertyValuestringoptional
Value of the property
401Returned when the request is unauthorized.

Error handling

A 401 is returned when the request is unauthorized. The authenticated user must have SYSTEM_CONFIGURATION or SYSTEM_CONFIGURATION_UPDATE permission. Each entry must include groupName and propertyName, which must contain 1 to 255 non-control characters; propertyValue must contain non-control characters when supplied.