GIgitguardian
Secrets

Request a new validity check of a secret

Changed on

Request a new validity check of a secret, to find out whether it is still valid.

The check runs asynchronously: a 202 means it was accepted, not that it completed. Read the secret validity back and compare its last_checked_at to get the refreshed validity.

A 202 does not guarantee that a new check was enqueued. No check runs for a secret checked less than 5 minutes ago, a secret with a validity override, or a secret GitGuardian cannot check.

Access requires the token to see at least one incident linked to the secret, private or public.

Prerequisites:

  • A valid API key with the secrets:write scope. Both personal access tokens and service account tokens are accepted.
  • Secret validity checks enabled for the workspace, otherwise a 403 is returned.
post/v1/secrets/{secret_id}/validity/check

Request

  • Base URL
    https://api.gitguardian.com
  • URL
    https://api.gitguardian.com/v1/secrets/{secret_id}/validity/check
  • Auth
    HTTP bearer

Path parameters

secret_idinteger required

The ID of the secret to check

Response

The validity check was accepted.

Changes