Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Honeytoken Sources

List sources on an honeytoken

List sources where a honeytoken appears.

get/v1/honeytokens/{honeytoken_id}/sources

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'source_id' | '-source_id'

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

provider_metadata_archivedboolean

Filter by whether the source is archived on the provider side when that information is available (e.g. archived repository). Sources without this metadata are treated as not archived for this filter.

Example:true

Response

Honeytoken Sources List

type'azure_devops' | 'bitbucket' | 'bitbucket_cloud' | 'github' | 'gitlab'
namestring
urlstring uri
open_issues_countnumber

Number of open secret issues with at least one occurrence on this source.

total_files_countnumber

Number of files where the honeytoken appears.

filesstring[]

Files where the honeytoken appears.

source_idnumber

Example response

[
  {
    "type": "github",
    "name": "gitguardian/gg-shield",
    "url": "https://github.com/GitGuardian/gg-shield",
    "open_issues_count": 3,
    "total_files_count": 2,
    "files": [
      ".env"
    ]
  }
]