HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Update OnGuard global settings

Update OnGuard global settings

Body Params
boolean

Enable access over Remote Desktop Session

int64

Cache Credentials Interval(in days)

boolean

Enable OnGuard requests load-balancing

integer
enum

OnGuard Health Check Interval (in hours)

Allowed:
boolean

Enable to hide Logout button

boolean

Enable to install VPN component

integer
enum

Keep-alive Interval (in seconds)

Allowed:
int64

Delay to bounce after Logout (in minutes)

string
enum

Run OnGuard As

Allowed:
string
enum

Server Certificate Validation

Allowed:
string
enum

Server Communication Mode

Allowed:
string

Support Team Email Address

boolean

Use Current OS Language (Windows only)

boolean

Enable to use Windows Single-Sign On

string

VPN Device Names (Windows)

string

VPN Device Names (macOS)

string

VPN Device Names (Linux)

string

[Deprecated] Allowed Subnets for Wired access

string

[Deprecated] Allowed Subnets for Wireless access

Responses

Language
Response
Choose an example:
application/json