defguard
  • Introduction
  • User documentation (help)
    • Configuring VPN
      • Defguard Desktop Client
        • Update instance
      • Other WireGuard® Clients
        • Configuring a device for new VPN Location manually
    • Password change / Reset
    • Enrollment & Onboarding
      • With internal Defguard SSO
      • With external SSO (Google/Microsoft/Custom)
    • Setting up 2FA/MFA
    • Desktop Client
    • CLI Client
  • Admin & features
    • Deploying your instance
      • One-line install script
      • Standalone package based installation
      • Docker images and tags
      • Docker Compose
      • Kubernetes
      • Upgrading
      • Gateway
        • Running gateway on MikroTik routers
      • Securing gRPC communication
      • OpenID RSA key
      • Configuration
      • Pre-production and development releases
      • High Availability and Failover
      • Health check
    • Features & configuration
      • Zero-Trust VPN with 2FA/MFA
        • Create/manage VPN Location
        • Network overview
        • Executing custom gateway commands
        • Multi-Factor Authentication (MFA/2FA)
          • MFA Architecture
        • Remote desktop client configuration
        • DNS and domains
      • Remote user enrollment
        • User onboarding after enrollment
      • SSO (OpenID Connect)
        • Portainer
        • Grafana setup
        • Proxmox
        • Matrix / Synapse
        • Django
        • MinIO
        • Vault
      • SMTP for email notifications
      • YubiKey Provisioning
      • Webhooks
      • Forward auth
      • SSH Authentication
      • Network devices
      • Gateway notifications
      • New version notifications
  • Troubleshooting Guide
    • Sending support information
    • Client Windows installer exit codes
    • Client "All traffic" connection issues
    • WebAuthn security keys
  • Enterprise Features
    • License
    • Enteprise features
      • Automatic (real time) desktop client configuration & sync
      • External OpenID providers
        • Google
        • Microsoft
        • Zitadel
        • Keycloak
        • JumpCloud
        • Okta
        • Custom
      • External OIDC secure enrollment
      • VPN & Client behavior customization
      • REST API
      • Access Control List
        • ACL Aliases
      • LDAP and Active Directory integration
        • Configuration
        • Settings table
        • Two-way LDAP and Active Directory synchronization
  • Tutorials
    • Step by step setting up a VPN server
      • Adding additional VPN locations
  • In depth
    • Roadmap
    • Architecture
      • How do VPN statistics work
      • Security concepts
  • For Developers
    • Contributing
    • Environment setup
    • Translations (core/web)
      • Switching language
      • Adding translations
  • Translations (client)
    • Adding translations
  • Contact us
    • Community & Support
Powered by GitBook
On this page
  • Core & Proxy
  • Rest Api
  • gRPC status health
  • Gateway

Was this helpful?

Edit on GitHub
  1. Admin & features
  2. Deploying your instance

Health check

PreviousHigh Availability and FailoverNextFeatures & configuration

Last updated 9 months ago

Was this helpful?

Core & Proxy

Rest Api

and provides health endpoint at GET /api/v1/health which checks whether the application server is running.

Example request:

curl "https://defguard.example.com/api/v1/health" 

Example response:

alive

gRPC status health

Proxy (available from v0.6.0)

To verify gRPC services for Proxy are alive, there is endpoint at GET /api/v1/health-grpc that verify it.

Example request:

curl "https://enroll.example.com/api/v1/health-grpc"

Possible responses:

200 - Proxy is working and is connected to CORE
503 - Proxy works but is not connected to CORE

Core (available from v1.0.0)

Example request for core:

./grpc_health_probe -addr=defguard.example.com:50055

Example response for core:

status: SERVING

Gateway

health_port = 55003

In this example gateway will open an additional HTTP port number 55003 and will return the following HTTP status codes:

  • 200 - Gateway is working and is connected to CORE
  • 503 - gateway works but is not connected to CORE

By default no healthcheck ports are open.

To check if core gRCP service is alive, we recommend to use community tools like .

You can enable in gateway config () a health check port, by adding the following line:

Core
Proxy
grpc_health_probe
example config