Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Honeytokens

List honeytokens

This endpoint allows you to list all the honeytokens of your workspace.

The response contains the list of honeytokens and a pagination cursor to retrieve the next page.

The honeytokens are sorted by id.

If you are using a personal access token, you need to have an access level superior or equal to manager.

get/v1/honeytokens

Query parameters

cursorstring

Pagination cursor.

per_pageinteger

Number of items to list per page.

status'triggered' | 'active' | 'revoked'

Status of a honeytoken.

type'AWS'

Type of a honeytoken.

searchstring

Search honeytokens based on their name and/or description.

creator_idnumber

Member id of the honeytoken creator.

revoker_idnumber

Member id of the honeytoken revoker.

creator_api_token_idstring

Token id of the honeytoken creator.

revoker_api_token_idstring

Token id of the honeytoken creator.

tagsstring

Comma-separated list of tags to filter on.

ordering'created_at' | '-created_at' | 'triggered_at' | '-triggered_at' | 'revoked_at' | '-revoked_at' | 'name' | '-name'

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

show_tokenboolean

Show token details (access_token_id and secret_key).

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

List honeytokens

idstring uuid
namestring
descriptionstring
created_atstring date-time

Creation date of the honeytoken

gitguardian_urlstring
status'active' | 'triggered' | 'revoked'

Status of the honeytoken.

triggered_atstring date-time

Date when the honeytoken was switched from active to triggered the last time

revoked_atstring date-time

Date when the honeytoken was revoked

open_events_countinteger
type'AWS'

Type of the honeytoken.

creator_idinteger nullable

Id of the member who created this honeytoken.

revoker_idinteger nullable

Id of the member who revoked this honeytoken.

creator_api_token_idstring uuid nullable

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

revoker_api_token_idstring uuid nullable

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

tokenobject

Secret to be placed as a honeytoken.

tagsstring[]

Example response

[
  {
    "id": "d45a123f-b15d-4fea-abf6-ff2a8479de5b",
    "name": "honeytoken A",
    "description": "honeytoken used in the repository AA",
    "created_at": "2019-08-22T14:15:22Z",
    "gitguardian_url": "https://dashboard.gitguardian.com/workspace/1/incidents/3bf0ed1b-68b2-4db8-b944-d450c5d35cf4",
    "status": "active",
    "triggered_at": "2019-08-22T14:15:22Z",
    "revoked_at": "2019-08-22T14:15:22Z",
    "open_events_count": 122,
    "type": "AWS",
    "creator_id": 122,
    "revoker_id": 122,
    "creator_api_token_id": "f74ffca5-d06d-45c2-a3d8-e8e95d15a464",
    "revoker_api_token_id": "19058e4a-0fab-4dcc-8ed6-4e2ec9fb2e44",
    "token": {
      "access_token_id": "AAAA",
      "secret_key": "BBB"
    },
    "tags": [
      "publicly_exposed"
    ],
    "custom_tags": [
      {
        "id": "d45a123f-b15d-4fea-abf6-ff2a8479de5b",
        "key": "env",
        "value": "prod"
      }
    ]
  }
]