Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Sources

Update a custom source

Update a custom source's name, description, and validators-only scan setting.

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

patch/v1/sources/custom-sources/{custom_source_id}

Path parameters

custom_source_idstring required
Example:123

The id of the custom source to update.

Request body

namestring required

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. Omit to leave the current value unchanged on update; defaults to false on creation.

Example request

{
  "name": "My Custom Source",
  "description": "A custom source for testing purposes"
}

Response

The custom source was updated successfully

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"
}