defguard
⌘Ctrlk
defguard
  • Welcome
  • Getting help
    • About Defguard
    • Features overview
    • One-line install script
    • Overview
    • Zero-Trust VPN with 2FA/MFA
    • Remote user enrollment
    • Internal SSO (OpenID Connect Provider)
    • External SSO/OpenID providers
    • LDAP and Active Directory integration
    • Firewall
    • Network devices
    • Activity & Audit logs
    • Notifications
    • Integrations
    • SSH Authentication
    • Forward auth
    • User SNAT bindings
    • Service locations
    • Desktop client auto-provisioning
    • Static IP assignment
    • Certificate management
    • Device posture verification
    • Managing Defguard via CLI
    • User management
    • Overview
    • Deploying to Production
    • Migration guides
    • Hardware, OS, network and firewall recommendations
    • Standalone package based installation
    • Docker Compose
    • Kubernetes
    • Terraform
    • OVA
    • Amazon Machine Image (AMI)
    • Configuration
    • Running Gateway on OPNsense firewall
    • Running Gateway on VyOS
    • Reverse Proxy configuration using NGINX
    • High Availability and Failover
    • Updating and version compatibility
    • Using a userspace WireGuard implementation
    • Pre-production and development releases
    • Health check
    • Production deployment verification guide
    • Linux Kernel WireGuard tuning
    • Programmatic gateway adoption
    • Gateway/Location VLAN routing
    • Purchasing and using the license
    • Overview
    • Mobile Client
    • Desktop Client
    • CLI Client
    • Other WireGuard® Clients
    • Password change / Reset
    • Enrollment & Onboarding
    • Setting up 2FA/MFA
    • Resolving Posture Check Failures
    • How to submit an issue
    • Sending support information
    • Using the Support Portal
    • Troubleshooting Guides
    • Server migration and licence transfer
    • Initial Setup Wizard: setting up from scratch
    • Migrating from Defguard 1.6 to 2.0
    • Adding Edge component
    • Defguard Compliance
    • Secure by design
    • Architecture
    • Architecture Decision Records
    • Client application feature compatibility
    • Defguard Open Organisation
    • BoringTun
    • Contributing
    • Environment setup
    • REST API
      • Core
        • System
        • Auth
        • User
        • Group
        • Device
        • Network Device
        • Static IP
        • Network
        • Location Stats
        • Gateway
        • Proxy
        • Certificates
        • SSH Key
        • API Token
        • Webhook
        • Settings
        • LDAP
        • Activity Log
        • ACL
        • Device Posture
        • SNAT
        • Open ID
        • OAuth2
        • Support
        • License
        • Models
Powered by GitBook
For the complete documentation index, see llms.txt. This page is also available as Markdown.
  1. 2.1
  2. For Developers
  3. REST API

Core

SystemAuthUserGroupDeviceNetwork DeviceStatic IPNetworkLocation StatsGatewayProxyCertificatesSSH KeyAPI TokenWebhookSettingsLDAPActivity LogACLDevice PostureSNATOpen IDOAuth2SupportLicenseModels
PreviousREST APINextSystem

Was this helpful?

Was this helpful?