GIgitguardian
Sources

Create custom source

Changed on

Create a new custom source for the authenticated account.

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

post/v1/sources/custom-sources

Request

  • Base URL
    https://api.gitguardian.com
  • URL
    https://api.gitguardian.com/v1/sources/custom-sources
  • Auth
    HTTP bearer

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

Custom source created 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"
}

Changes

  • 288c9a3b277dRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status