Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Honeytokens Events

List all honeytokens events

List events related to all honeytokens of the workspace.

get/v1/honeytokens_events

Query parameters

cursorstring

Pagination cursor.

per_pageinteger

Number of items to list per page.

ordering'triggered_at' | '-triggered_at'

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

honeytoken_idstring uuid
Example:d45a123f-b15d-4fea-abf6-ff2a8479de5b

Filter by honeytoken id

status'open' | 'archived' | 'allowed'

Filter by status

ip_addressstring
Example:8.8.8.8

Filter by ip address

tagsstring

Comma-separated list of tags to filter on

searchstring
Example:I revoked this

Search events based on the data field content

Headers

X-Privacy-Mode'true' | 'false'

When set to true, sensitive values in the response are obfuscated (replaced with <GG>OBFUSCATED</GG>). Useful for sharing API responses without exposing sensitive data.

Response

Honeytokens Events List

idstring uuid
honeytoken_idstring uuid

Id of the related Honeytoken.

triggered_atstring date-time

The time on which the honeytoken was triggered. Null if the honeytoken was never triggered.

gitguardian_urlstring
status'open' | 'closed'

Status of the honeytoken event.

ip_addressstring

IP address from which the event originates.

actionstring

The action made through the honeytoken.

dataobject

An object with additional data related to the event

tagsstring[]

Example response

[
  {
    "id": "0cad1887-d616-4a46-8b5e-4c7b3a70dbaf",
    "honeytoken_id": "d45a123f-b15d-4fea-abf6-ff2a8479de5b",
    "triggered_at": "2019-08-22T14:15:22Z",
    "gitguardian_url": "https://dashboard.gitguardian.com/workspace/1/incidents/3bf0ed1b-68b2-4db8-b944-d450c5d35cf4",
    "status": "open",
    "ip_address": "8.8.8.8",
    "tags": [
      "publicly_exposed"
    ]
  }
]