Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Secrets

Get the validity of a secret

Retrieve the current validity status of a secret together with its validity override. validity_override is null when no override is set.

Prerequisites:

  • A valid API key with the secrets:read scope.
get/v1/secrets/{secret_id}/validity

Path parameters

secret_idinteger required

The ID of the secret

Response

The secret validity and validity override.

idinteger
validity'valid' | 'invalid' | 'failed_to_check' | 'no_checker' | 'unknown' nullable

Current validity of the secret (reflects the override while it is set).

validity_override'valid' | 'invalid' | 'failed_to_check' | 'no_checker' | 'unknown' nullable

The validity override currently set on the secret, or null if none.

Example response

{
  "id": 1,
  "validity": "invalid",
  "validity_override": "invalid"
}