> For the complete documentation index, see [llms.txt](https://learn.netmaker.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://learn.netmaker.io/api-spec/server.md). # Server ## GET /api/server/feature\_flags > Get feature flags for this server ```json {"openapi":"3.1.1","info":{"title":"NetMaker","version":"1.4.0"},"tags":[],"servers":[{"url":"http://api.demo.netmaker.io"}],"paths":{"/api/server/feature_flags":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/models.FeatureFlags"}}}}},"summary":"Get feature flags for this server","tags":["Server"]}}},"components":{"schemas":{"models.FeatureFlags":{"properties":{"allow_multi_server_license":{"type":"boolean"},"enable_device_approval":{"type":"boolean"},"enable_egress_ha":{"type":"boolean"},"enable_flow_logs":{"type":"boolean"},"enable_gws_ha":{"type":"boolean"},"enable_idp_integration":{"type":"boolean"},"enable_jit":{"type":"boolean"},"enable_network_activity":{"type":"boolean"},"enable_oauth":{"type":"boolean"},"enable_overlapping_egress_ranges":{"type":"boolean"},"enable_posture_checks":{"type":"boolean"}},"type":"object"}}}} ``` ## GET /api/server/getconfig > Get the server configuration ```json {"openapi":"3.1.1","info":{"title":"NetMaker","version":"1.4.0"},"tags":[],"servers":[{"url":"http://api.demo.netmaker.io"}],"security":[{"oauth":[]}],"paths":{"/api/server/getconfig":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/models.ServerConfig"}}}}},"summary":"Get the server configuration","tags":["Server"]}}},"components":{"schemas":{"models.ServerConfig":{"properties":{"Is_EE":{"type":"boolean"},"api":{"type":"string"},"apihost":{"type":"string"},"apiport":{"type":"string"},"broker":{"type":"string"},"brokerType":{"type":"string"},"coreDNSAddr":{"type":"string"},"defaultDomain":{"type":"string"},"dnsmode":{"type":"string"},"endpointDetection":{"type":"boolean"},"grpc":{"type":"string"},"ipdetectionInterval":{"type":"integer"},"manageDNS":{"type":"boolean"},"metricInterval":{"type":"string"},"metricsPort":{"type":"integer"},"mqpassword":{"type":"string"},"mqport":{"type":"string"},"mquserName":{"type":"string"},"peerConnectionCheckInterval":{"type":"string"},"server":{"type":"string"},"stun":{"type":"boolean"},"stunServers":{"type":"string"},"trafficKey":{"items":{"type":"integer"},"type":"array"},"version":{"type":"string"}},"type":"object"}}}} ``` ## GET /api/server/getserverinfo > Get the server information ```json {"openapi":"3.1.1","info":{"title":"NetMaker","version":"1.4.0"},"tags":[],"servers":[{"url":"http://api.demo.netmaker.io"}],"security":[{"oauth":[]}],"paths":{"/api/server/getserverinfo":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/models.ServerConfig"}}}}},"summary":"Get the server information","tags":["Server"]}}},"components":{"schemas":{"models.ServerConfig":{"properties":{"Is_EE":{"type":"boolean"},"api":{"type":"string"},"apihost":{"type":"string"},"apiport":{"type":"string"},"broker":{"type":"string"},"brokerType":{"type":"string"},"coreDNSAddr":{"type":"string"},"defaultDomain":{"type":"string"},"dnsmode":{"type":"string"},"endpointDetection":{"type":"boolean"},"grpc":{"type":"string"},"ipdetectionInterval":{"type":"integer"},"manageDNS":{"type":"boolean"},"metricInterval":{"type":"string"},"metricsPort":{"type":"integer"},"mqpassword":{"type":"string"},"mqport":{"type":"string"},"mquserName":{"type":"string"},"peerConnectionCheckInterval":{"type":"string"},"server":{"type":"string"},"stun":{"type":"boolean"},"stunServers":{"type":"string"},"trafficKey":{"items":{"type":"integer"},"type":"array"},"version":{"type":"string"}},"type":"object"}}}} ``` ## GET /api/server/settings > Get the server settings ```json {"openapi":"3.1.1","info":{"title":"NetMaker","version":"1.4.0"},"tags":[],"servers":[{"url":"http://api.demo.netmaker.io"}],"security":[{"oauth":[]}],"paths":{"/api/server/settings":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/models.ServerSettings"}}}}},"summary":"Get the server settings","tags":["Server"]}}},"components":{"schemas":{"models.ServerSettings":{"properties":{"allowed_email_domains":{"type":"string"},"audit_logs_retention_period":{"type":"integer"},"authprovider":{"type":"string"},"azure_tenant":{"type":"string"},"basic_auth":{"type":"boolean"},"clean_up_interval_in_mins":{"type":"integer"},"client_id":{"type":"string"},"client_secret":{"type":"string"},"default_domain":{"type":"string"},"email_sender_addr":{"type":"string"},"email_sender_password":{"type":"string"},"email_sender_user":{"type":"string"},"enable_flow_logs":{"type":"boolean"},"endpoint_detection":{"type":"boolean"},"google_admin_email":{"type":"string"},"google_sa_creds_json":{"type":"string"},"group_filters":{"items":{"type":"string"},"type":"array"},"idp_sync_interval":{"type":"string"},"ip_detection_interval":{"description":"IPDetectionInterval is the interval (in seconds) at which devices check for changes in public ip.","type":"integer"},"jwt_validity_duration":{"description":"JwtValidityDuration is the validity duration of auth tokens for users\non the dashboard (NMUI).","type":"integer"},"jwt_validity_duration_clients":{"description":"JwtValidityDurationClients is the validity duration of auth tokens for\nusers on the clients (NetDesk).","type":"integer"},"manage_dns":{"type":"boolean"},"metric_interval":{"type":"string"},"metrics_port":{"type":"integer"},"mfa_enforced":{"type":"boolean"},"netclientautoupdate":{"type":"boolean"},"oidcissuer":{"type":"string"},"okta_api_token":{"type":"string"},"okta_org_url":{"type":"string"},"old_acl_support":{"type":"boolean"},"peer_connection_check_interval":{"type":"string"},"posture_check_interval":{"description":"in minutes","type":"string"},"rac_restrict_to_single_network":{"type":"boolean"},"smtp_host":{"type":"string"},"smtp_port":{"type":"integer"},"stun":{"type":"boolean"},"stun_servers":{"type":"string"},"sync_enabled":{"type":"boolean"},"telemetry":{"type":"string"},"user_filters":{"items":{"type":"string"},"type":"array"},"verbosity":{"type":"integer"}},"type":"object"}}}} ``` ## PUT /api/server/settings > Update the server settings ```json {"openapi":"3.1.1","info":{"title":"NetMaker","version":"1.4.0"},"tags":[],"servers":[{"url":"http://api.demo.netmaker.io"}],"security":[{"oauth":[]}],"paths":{"/api/server/settings":{"put":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/models.ServerSettings"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/models.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/models.ErrorResponse"}}}}},"summary":"Update the server settings","tags":["Server"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/models.ServerSettings"}}},"description":"Server settings","required":true}}}},"components":{"schemas":{"models.ServerSettings":{"properties":{"allowed_email_domains":{"type":"string"},"audit_logs_retention_period":{"type":"integer"},"authprovider":{"type":"string"},"azure_tenant":{"type":"string"},"basic_auth":{"type":"boolean"},"clean_up_interval_in_mins":{"type":"integer"},"client_id":{"type":"string"},"client_secret":{"type":"string"},"default_domain":{"type":"string"},"email_sender_addr":{"type":"string"},"email_sender_password":{"type":"string"},"email_sender_user":{"type":"string"},"enable_flow_logs":{"type":"boolean"},"endpoint_detection":{"type":"boolean"},"google_admin_email":{"type":"string"},"google_sa_creds_json":{"type":"string"},"group_filters":{"items":{"type":"string"},"type":"array"},"idp_sync_interval":{"type":"string"},"ip_detection_interval":{"description":"IPDetectionInterval is the interval (in seconds) at which devices check for changes in public ip.","type":"integer"},"jwt_validity_duration":{"description":"JwtValidityDuration is the validity duration of auth tokens for users\non the dashboard (NMUI).","type":"integer"},"jwt_validity_duration_clients":{"description":"JwtValidityDurationClients is the validity duration of auth tokens for\nusers on the clients (NetDesk).","type":"integer"},"manage_dns":{"type":"boolean"},"metric_interval":{"type":"string"},"metrics_port":{"type":"integer"},"mfa_enforced":{"type":"boolean"},"netclientautoupdate":{"type":"boolean"},"oidcissuer":{"type":"string"},"okta_api_token":{"type":"string"},"okta_org_url":{"type":"string"},"old_acl_support":{"type":"boolean"},"peer_connection_check_interval":{"type":"string"},"posture_check_interval":{"description":"in minutes","type":"string"},"rac_restrict_to_single_network":{"type":"boolean"},"smtp_host":{"type":"string"},"smtp_port":{"type":"integer"},"stun":{"type":"boolean"},"stun_servers":{"type":"string"},"sync_enabled":{"type":"boolean"},"telemetry":{"type":"string"},"user_filters":{"items":{"type":"string"},"type":"array"},"verbosity":{"type":"integer"}},"type":"object"},"models.ErrorResponse":{"properties":{"code":{"type":"integer"},"message":{"type":"string"},"response":{}},"type":"object"}}}} ``` ## GET /api/server/status > Get the server status ```json {"openapi":"3.1.1","info":{"title":"NetMaker","version":"1.4.0"},"tags":[],"servers":[{"url":"http://api.demo.netmaker.io"}],"paths":{"/api/server/status":{"get":{"responses":{"200":{"description":"Server status","content":{"application/json":{"schema":{"type":"object"}}}}},"summary":"Get the server status","tags":["Server"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://learn.netmaker.io/api-spec/server.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.