View various Global Settings

Prev Next

Get

/global-settings

View various Global Settings.

Security

HTTP

Type bearer

Responses

200

Global Settings.

Expand All

object

claimsTokenExpiration

number

Number of minutes the Claims Token is valid both for administrators and clients.

Example1440

entitlementTokenExpiration

number

Number of minutes the Entitlement Token is valid for clients.

Example180

administrationTokenExpiration

number

Number of minutes the administration Token is valid for administrators.

Example720

vpnCertificateExpiration

number

Number of minutes the VPN certificates is valid for clients.

Example525600

registeredDeviceExpirationDays

number

Number of days registered devices are kept in storage before being deleted.

Example90

spaMode

string

SPA mode.

Valid values[ "TCP", "UDP-TCP" ]

spaTimeWindowSeconds

number

Number of seconds the time skew SPA will allow.

Default600

loginBannerMessage

string

The configured message will be displayed on the sign-in UI.

ExampleAuthorized use only.

messageOfTheDay

string

The configured message will be displayed after a successful login.

ExampleWelcome to Appgate SDP.

backupApiEnabled

boolean

Whether the backup API is enabled or not.

applianceKeyEncryption

boolean

Enables TPM2-based appliance key encryption on all Appliances.

Defaultfalse

ppModeEnabled

boolean

Whether Protection Profile mode enabled or not. Limits certain functionalities.

Defaultfalse

geoIpSettings

object (GeoIpSettings)

GeoIP provider settings supporting multiple providers.

updates

string

Selected GeoIP provider when enabled.

Valid values[ "Disabled", "Default", "Maxmind", "IPInfo", "Custom" ]

Default"Disabled"

ExampleDefault

maxmind

object

MaxMind provider configuration. Required if provider is Maxmind.

accountId

integer

MaxMind account ID.

Minimum1

Example123456

ipInfo

object

IPInfo provider configuration. Required if provider is IPInfo.

databaseId

string

Can be one of the predefined values: "ipinfo_lite", "ipinfo_core", "ipinfo_plus", "ipinfo_location", "location_extended_v2", or a custom database name for future IPinfo additions.

Exampleipinfo_lite

custom

object

Custom provider configuration. Required if provider is Custom.

url

string

Custom provider base URL.

Examplehttps://geoip.example.com

inactivityTimeoutEnabled

boolean

Whether user session inactivity timeout is enabled or not.

Defaulttrue

inactivityTimeout

number

Number of minutes of inactivity before a user session is terminated. Minimum value is 1 minute. Not applicable if inactivity timeout is disabled.

Minimum1

Default60

Example15

auditLogPersistenceMode

string

Audit Log persistence mode.

Valid values[ "Default", "Guaranteed", "Performance" ]

profileHostname

string

The hostname to use for generating profile URLs.

Exampleappgate.company.com

collectiveName

string

Friendly name for the Collective.

ExampleTest Collective

collectiveId

string (uuid)

A randomly generated ID during first installation to identify the Collective.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc

401

Token error. Login again.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

500

Unexpected server side error.

object

Generic HTTP error.

string

Machine readable error code.

message

string

Human readable error details.

Was this article helpful?