Dependency-Track unofficial
POST/v1/team/key/{publicIdOrKey}/comment

Update an API key comment

Updates the comment on an API key identified by its public ID or, for a legacy key, its complete key value. Send the comment as a plain-text request body; the authenticated user must have ACCESS_MANAGEMENT or ACCESS_MANAGEMENT_UPDATE permission. A successful response returns the updated API key.

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

1 parameter
publicIdOrKeystringrequired
The API key's public ID, or the complete key value when identifying a legacy key.

3 status codes
200Returns the updated API key object, including its comment, public ID, masked key, legacy status, and timestamps.
commentstringoptional
createdintegeroptional
UNIX epoch timestamp in milliseconds
expiresAtintegeroptional
UNIX epoch timestamp in milliseconds
keystringoptional
lastUsedintegeroptional
UNIX epoch timestamp in milliseconds
legacybooleanoptional
maskedKeystringoptional
publicIdstringoptional
401Returned when the request is unauthorized.
404Returned when the API key could not be found.

Error handling

A 401 is returned when the request is unauthorized; the authenticated user must have ACCESS_MANAGEMENT or ACCESS_MANAGEMENT_UPDATE permission. A 404 is returned when the API key identified by the publicIdOrKey path parameter cannot be found.