---
title: "Update a custom source"
method: PATCH
path: "/v1/sources/custom-sources/{custom_source_id}"
tags: ["Sources"]
---

# Update a custom source

`PATCH /v1/sources/custom-sources/{custom_source_id}`

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.

## Path parameters

- `custom_source_id` string, required

## Request body

- object — **⚠️ Beta Version**: This schema is in beta and may be subject to changes in future releases.
  - `name` string, required — The name of the custom source
  - `description` string, nullable — The description of the custom source
  - `use_only_detectors_with_validators` boolean — 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.

## Response `200`

The custom source was updated successfully

- object — **⚠️ Beta Version**: This schema is in beta and may be subject to changes in future releases.
  - `id` string — The ID of the custom source
  - `source_uuid` string — Unique identifier for the custom source
  - `name` string — The name of the custom source
  - `description` string, nullable — The description of the custom source
  - `use_only_detectors_with_validators` boolean — When true, scans of this source only keep secrets whose detector supports validity checks.

## Other responses

- `400` — Invalid data
- `401` — Invalid API key
- `403` — Forbidden
- `404` — Resource not found
- `503` — API under maintenance

---

[API](https://skmtc.net/gitguardian/apis/gitguardian-api.md) · [All operations](https://skmtc.net/gitguardian/apis/gitguardian-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gitguardian/gitguardian-api/revisions/511b067cdcb1/schema)