Defguard
Search
⌃
K
Introduction
User documentation (help)
Changing your password
Setting up 2FA/MFA
Adding a device (connecting to VPN)
Configuring a device for a new VPN Location
Remote user enrollment
Setting up SMTP for email notifications
Sending support information
Features
Deploying your instance
One-line install script
Configuration
Docker Compose
Kubernetes
Gateway
Health check
OpenID Connect
LDAP synchronization
Wireguard
YubiKey Provisioning
Webhooks
Forward auth
SSH Authentication
In depth
Roadmap
Changelog
Architecture Overview
For Developers
Contributing
Environment setup
Translations ( web )
Other resources
Contact us
Community & Support
Powered By
GitBook
Comment on page
Health check
Core
and
Proxy
provides health endpoint at
GET /api/v1/health
which checks whether the application server is running. It does not verify the other services like
Gateway
and database are running.
Example request:
curl
"https://defguard.com/api/v1/health"
Example response:
alive
Previous
Gateway
Next - Features
OpenID Connect
Last modified
19d ago