Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Sources

List custom sources

List custom sources for the authenticated account.

⚠️ Beta Version: This endpoint is in beta and may be subject to changes in future releases.

get/v1/sources/custom-sources

Query parameters

cursorstring

Pagination cursor.

pageinteger

Page number.

per_pageinteger

Number of items to list per page.

searchstring

Custom sources matching this search.

Example:my-custom-source
ordering'id' | '-id' | 'name' | '-name'

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

Response

Custom Source List

idstring

The ID of the custom source

source_uuidstring

Unique identifier for the custom source

namestring

The name of the custom source

descriptionstring nullable

The description of the custom source

use_only_detectors_with_validatorsboolean

When true, scans of this source only keep secrets whose detector supports validity checks.

Example response

[
  {
    "id": "123",
    "source_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My Custom Source",
    "description": "A custom source for testing purposes"
  }
]