Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Internal Secret Incident Notes

Update a secret incident note

Update an existing comment on a secret incident. Only incident notes created by the current API key can be updated.

patch/v1/incidents/secrets/{incident_id}/notes/{note_id}

Path parameters

incident_idinteger required

The id of the incident to retrieve

note_idinteger required

The id of the incident note to update

Request body

commentstring required

Content of the incident note

Example request

{
  "comment": "I revoked this secret"
}

Response

The note was updated successfully.

idinteger
incident_idinteger

Id of the related Incident

member_idinteger nullable

Id of the member who created this note. Can be null if the note was not created by a member or if the member was deleted.

api_tokenstring nullable

Name of the API key which created this note. Can be null if the note was not created via the API. Use api_token_id instead.

api_token_idstring uuid nullable

ID of the API key which created this note. Can be null if the note was not created via the API.

created_atstring date-time

Creation date of the note

updated_atstring date-time nullable

Last time the content of the note was updated. Null if the comment was never modified.

commentstring nullable
issue_idinteger

Id of the related Incident. Use incident_id instead.

user_idinteger nullable

Id of the user who created this note. Can be null if the note was not created by a user or if the user was deleted. Use member_id instead.

Example response

{
  "id": 17,
  "incident_id": 42,
  "member_id": 38,
  "api_token_id": "3220d951-00ce-446c-ac90-9822f0f9b71e",
  "created_at": "2019-08-22T14:15:22Z",
  "comment": "I revoked this secret",
  "issue_id": 42,
  "user_id": 38
}