Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Honeytoken Notes

List notes on an honeytoken

List notes left on a honeytoken in chronological order.

get/v1/honeytokens/{honeytoken_id}/notes

Path parameters

honeytoken_idstring uuid required

The id of the honeytoken to retrieve

Query parameters

cursorstring

Pagination cursor.

per_pageinteger

Number of items to list per page.

ordering'created_at' | '-created_at' | 'updated_at' | '-updated_at'

Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.

member_idinteger
Example:1

Filter by member id.

api_token_idstring uuid
Example:fdf075f9-1662-4cf1-9171-af50568158a8

Entries matching this API token id.

searchstring

Search notes based on the comment field content.

Example:I revoked this

Response

Honeytoken Note List

idstring uuid
honeytoken_idstring uuid

Id of the related Honeytoken

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_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

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

commentstring

Example response

[
  {
    "id": "1b99892e-6254-4f8a-9e98-559ed810b7da",
    "honeytoken_id": "d45a123f-b15d-4fea-abf6-ff2a8479de5b",
    "member_id": 38,
    "api_token_id": "37d5b0d7-9f89-4b80-9070-261e26637836",
    "created_at": "2019-08-22T14:15:22Z",
    "comment": "I revoked this secret"
  }
]