Skip to main content

ggshield api-status

Description

Show API status and version, along with API key and instance sources.

ggshield api-status [OPTIONS]

Options

  • --format [text|json]: Format to use for the output.
  • --json: Shorthand for --format json.
  • --instance URL: URL of the instance to use.

This command supports all ggshield global options.

Examples

$ ggshield api-status
API URL: https://api.gitguardian.com
Status: healthy
App version: v2.22.1
Secrets engine version: 2.83.0