Server

Get feature flags for this server

get

Responses

200

OK

application/json

allow_multi_server_licensebooleanOptional

enable_device_approvalbooleanOptional

enable_egress_habooleanOptional

enable_flow_logsbooleanOptional

enable_gws_habooleanOptional

enable_idp_integrationbooleanOptional

enable_jitbooleanOptional

enable_network_activitybooleanOptional

enable_oauthbooleanOptional

enable_overlapping_egress_rangesbooleanOptional

enable_posture_checksbooleanOptional

get

/api/server/feature_flags

HTTPcURLJavaScriptPython

GET /api/server/feature_flags HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

200

OK

{
  "allow_multi_server_license": true,
  "enable_device_approval": true,
  "enable_egress_ha": true,
  "enable_flow_logs": true,
  "enable_gws_ha": true,
  "enable_idp_integration": true,
  "enable_jit": true,
  "enable_network_activity": true,
  "enable_oauth": true,
  "enable_overlapping_egress_ranges": true,
  "enable_posture_checks": true
}

Get the server configuration

get

Authorizations

oauth

Responses

200

OK

application/json

Is_EEbooleanOptional

apistringOptional

apihoststringOptional

apiportstringOptional

brokerstringOptional

brokerTypestringOptional

coreDNSAddrstringOptional

defaultDomainstringOptional

dnsmodestringOptional

endpointDetectionbooleanOptional

grpcstringOptional

ipdetectionIntervalintegerOptional

manageDNSbooleanOptional

metricIntervalstringOptional

metricsPortintegerOptional

mqpasswordstringOptional

mqportstringOptional

mquserNamestringOptional

peerConnectionCheckIntervalstringOptional

serverstringOptional

stunbooleanOptional

stunServersstringOptional

trafficKeyinteger[]Optional

versionstringOptional

get

/api/server/getconfig

HTTPcURLJavaScriptPython

GET /api/server/getconfig HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

200

OK

{
  "Is_EE": true,
  "api": "text",
  "apihost": "text",
  "apiport": "text",
  "broker": "text",
  "brokerType": "text",
  "coreDNSAddr": "text",
  "defaultDomain": "text",
  "dnsmode": "text",
  "endpointDetection": true,
  "grpc": "text",
  "ipdetectionInterval": 1,
  "manageDNS": true,
  "metricInterval": "text",
  "metricsPort": 1,
  "mqpassword": "text",
  "mqport": "text",
  "mquserName": "text",
  "peerConnectionCheckInterval": "text",
  "server": "text",
  "stun": true,
  "stunServers": "text",
  "trafficKey": [
    1
  ],
  "version": "text"
}

Get the server information

get

Authorizations

oauth

Responses

200

OK

application/json

Is_EEbooleanOptional

apistringOptional

apihoststringOptional

apiportstringOptional

brokerstringOptional

brokerTypestringOptional

coreDNSAddrstringOptional

defaultDomainstringOptional

dnsmodestringOptional

endpointDetectionbooleanOptional

grpcstringOptional

ipdetectionIntervalintegerOptional

manageDNSbooleanOptional

metricIntervalstringOptional

metricsPortintegerOptional

mqpasswordstringOptional

mqportstringOptional

mquserNamestringOptional

peerConnectionCheckIntervalstringOptional

serverstringOptional

stunbooleanOptional

stunServersstringOptional

trafficKeyinteger[]Optional

versionstringOptional

get

/api/server/getserverinfo

HTTPcURLJavaScriptPython

GET /api/server/getserverinfo HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

200

OK

{
  "Is_EE": true,
  "api": "text",
  "apihost": "text",
  "apiport": "text",
  "broker": "text",
  "brokerType": "text",
  "coreDNSAddr": "text",
  "defaultDomain": "text",
  "dnsmode": "text",
  "endpointDetection": true,
  "grpc": "text",
  "ipdetectionInterval": 1,
  "manageDNS": true,
  "metricInterval": "text",
  "metricsPort": 1,
  "mqpassword": "text",
  "mqport": "text",
  "mquserName": "text",
  "peerConnectionCheckInterval": "text",
  "server": "text",
  "stun": true,
  "stunServers": "text",
  "trafficKey": [
    1
  ],
  "version": "text"
}

Get the server settings

get

Authorizations

oauth

Responses

200

OK

application/json

allowed_email_domainsstringOptional

audit_logs_retention_periodintegerOptional

authproviderstringOptional

azure_tenantstringOptional

basic_authbooleanOptional

clean_up_interval_in_minsintegerOptional

client_idstringOptional

client_secretstringOptional

default_domainstringOptional

email_sender_addrstringOptional

email_sender_passwordstringOptional

email_sender_userstringOptional

enable_flow_logsbooleanOptional

endpoint_detectionbooleanOptional

google_admin_emailstringOptional

google_sa_creds_jsonstringOptional

group_filtersstring[]Optional

idp_sync_intervalstringOptional

ip_detection_intervalintegerOptional

IPDetectionInterval is the interval (in seconds) at which devices check for changes in public ip.

jwt_validity_durationintegerOptional

JwtValidityDuration is the validity duration of auth tokens for users on the dashboard (NMUI).

jwt_validity_duration_clientsintegerOptional

JwtValidityDurationClients is the validity duration of auth tokens for users on the clients (NetDesk).

manage_dnsbooleanOptional

metric_intervalstringOptional

metrics_portintegerOptional

mfa_enforcedbooleanOptional

netclientautoupdatebooleanOptional

oidcissuerstringOptional

okta_api_tokenstringOptional

okta_org_urlstringOptional

old_acl_supportbooleanOptional

peer_connection_check_intervalstringOptional

posture_check_intervalstringOptional

in minutes

rac_restrict_to_single_networkbooleanOptional

smtp_hoststringOptional

smtp_portintegerOptional

stunbooleanOptional

stun_serversstringOptional

sync_enabledbooleanOptional

telemetrystringOptional

user_filtersstring[]Optional

verbosityintegerOptional

get

/api/server/settings

HTTPcURLJavaScriptPython

GET /api/server/settings HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

200

OK

{
  "allowed_email_domains": "text",
  "audit_logs_retention_period": 1,
  "authprovider": "text",
  "azure_tenant": "text",
  "basic_auth": true,
  "clean_up_interval_in_mins": 1,
  "client_id": "text",
  "client_secret": "text",
  "default_domain": "text",
  "email_sender_addr": "text",
  "email_sender_password": "text",
  "email_sender_user": "text",
  "enable_flow_logs": true,
  "endpoint_detection": true,
  "google_admin_email": "text",
  "google_sa_creds_json": "text",
  "group_filters": [
    "text"
  ],
  "idp_sync_interval": "text",
  "ip_detection_interval": 1,
  "jwt_validity_duration": 1,
  "jwt_validity_duration_clients": 1,
  "manage_dns": true,
  "metric_interval": "text",
  "metrics_port": 1,
  "mfa_enforced": true,
  "netclientautoupdate": true,
  "oidcissuer": "text",
  "okta_api_token": "text",
  "okta_org_url": "text",
  "old_acl_support": true,
  "peer_connection_check_interval": "text",
  "posture_check_interval": "text",
  "rac_restrict_to_single_network": true,
  "smtp_host": "text",
  "smtp_port": 1,
  "stun": true,
  "stun_servers": "text",
  "sync_enabled": true,
  "telemetry": "text",
  "user_filters": [
    "text"
  ],
  "verbosity": 1
}

Update the server settings

put

Authorizations

oauth

Body

application/json

allowed_email_domainsstringOptional

audit_logs_retention_periodintegerOptional

authproviderstringOptional

azure_tenantstringOptional

basic_authbooleanOptional

clean_up_interval_in_minsintegerOptional

client_idstringOptional

client_secretstringOptional

default_domainstringOptional

email_sender_addrstringOptional

email_sender_passwordstringOptional

email_sender_userstringOptional

enable_flow_logsbooleanOptional

endpoint_detectionbooleanOptional

google_admin_emailstringOptional

google_sa_creds_jsonstringOptional

group_filtersstring[]Optional

idp_sync_intervalstringOptional

ip_detection_intervalintegerOptional

IPDetectionInterval is the interval (in seconds) at which devices check for changes in public ip.

jwt_validity_durationintegerOptional

JwtValidityDuration is the validity duration of auth tokens for users on the dashboard (NMUI).

jwt_validity_duration_clientsintegerOptional

JwtValidityDurationClients is the validity duration of auth tokens for users on the clients (NetDesk).

manage_dnsbooleanOptional

metric_intervalstringOptional

metrics_portintegerOptional

mfa_enforcedbooleanOptional

netclientautoupdatebooleanOptional

oidcissuerstringOptional

okta_api_tokenstringOptional

okta_org_urlstringOptional

old_acl_supportbooleanOptional

peer_connection_check_intervalstringOptional

posture_check_intervalstringOptional

in minutes

rac_restrict_to_single_networkbooleanOptional

smtp_hoststringOptional

smtp_portintegerOptional

stunbooleanOptional

stun_serversstringOptional

sync_enabledbooleanOptional

telemetrystringOptional

user_filtersstring[]Optional

verbosityintegerOptional

Responses

200

OK

application/json

allowed_email_domainsstringOptional

audit_logs_retention_periodintegerOptional

authproviderstringOptional

azure_tenantstringOptional

basic_authbooleanOptional

clean_up_interval_in_minsintegerOptional

client_idstringOptional

client_secretstringOptional

default_domainstringOptional

email_sender_addrstringOptional

email_sender_passwordstringOptional

email_sender_userstringOptional

enable_flow_logsbooleanOptional

endpoint_detectionbooleanOptional

google_admin_emailstringOptional

google_sa_creds_jsonstringOptional

group_filtersstring[]Optional

idp_sync_intervalstringOptional

ip_detection_intervalintegerOptional

IPDetectionInterval is the interval (in seconds) at which devices check for changes in public ip.

jwt_validity_durationintegerOptional

JwtValidityDuration is the validity duration of auth tokens for users on the dashboard (NMUI).

jwt_validity_duration_clientsintegerOptional

JwtValidityDurationClients is the validity duration of auth tokens for users on the clients (NetDesk).

manage_dnsbooleanOptional

metric_intervalstringOptional

metrics_portintegerOptional

mfa_enforcedbooleanOptional

netclientautoupdatebooleanOptional

oidcissuerstringOptional

okta_api_tokenstringOptional

okta_org_urlstringOptional

old_acl_supportbooleanOptional

peer_connection_check_intervalstringOptional

posture_check_intervalstringOptional

in minutes

rac_restrict_to_single_networkbooleanOptional

smtp_hoststringOptional

smtp_portintegerOptional

stunbooleanOptional

stun_serversstringOptional

sync_enabledbooleanOptional

telemetrystringOptional

user_filtersstring[]Optional

verbosityintegerOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

put

/api/server/settings

HTTPcURLJavaScriptPython

PUT /api/server/settings HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 1003

{
  "allowed_email_domains": "text",
  "audit_logs_retention_period": 1,
  "authprovider": "text",
  "azure_tenant": "text",
  "basic_auth": true,
  "clean_up_interval_in_mins": 1,
  "client_id": "text",
  "client_secret": "text",
  "default_domain": "text",
  "email_sender_addr": "text",
  "email_sender_password": "text",
  "email_sender_user": "text",
  "enable_flow_logs": true,
  "endpoint_detection": true,
  "google_admin_email": "text",
  "google_sa_creds_json": "text",
  "group_filters": [
    "text"
  ],
  "idp_sync_interval": "text",
  "ip_detection_interval": 1,
  "jwt_validity_duration": 1,
  "jwt_validity_duration_clients": 1,
  "manage_dns": true,
  "metric_interval": "text",
  "metrics_port": 1,
  "mfa_enforced": true,
  "netclientautoupdate": true,
  "oidcissuer": "text",
  "okta_api_token": "text",
  "okta_org_url": "text",
  "old_acl_support": true,
  "peer_connection_check_interval": "text",
  "posture_check_interval": "text",
  "rac_restrict_to_single_network": true,
  "smtp_host": "text",
  "smtp_port": 1,
  "stun": true,
  "stun_servers": "text",
  "sync_enabled": true,
  "telemetry": "text",
  "user_filters": [
    "text"
  ],
  "verbosity": 1
}

{
  "allowed_email_domains": "text",
  "audit_logs_retention_period": 1,
  "authprovider": "text",
  "azure_tenant": "text",
  "basic_auth": true,
  "clean_up_interval_in_mins": 1,
  "client_id": "text",
  "client_secret": "text",
  "default_domain": "text",
  "email_sender_addr": "text",
  "email_sender_password": "text",
  "email_sender_user": "text",
  "enable_flow_logs": true,
  "endpoint_detection": true,
  "google_admin_email": "text",
  "google_sa_creds_json": "text",
  "group_filters": [
    "text"
  ],
  "idp_sync_interval": "text",
  "ip_detection_interval": 1,
  "jwt_validity_duration": 1,
  "jwt_validity_duration_clients": 1,
  "manage_dns": true,
  "metric_interval": "text",
  "metrics_port": 1,
  "mfa_enforced": true,
  "netclientautoupdate": true,
  "oidcissuer": "text",
  "okta_api_token": "text",
  "okta_org_url": "text",
  "old_acl_support": true,
  "peer_connection_check_interval": "text",
  "posture_check_interval": "text",
  "rac_restrict_to_single_network": true,
  "smtp_host": "text",
  "smtp_port": 1,
  "stun": true,
  "stun_servers": "text",
  "sync_enabled": true,
  "telemetry": "text",
  "user_filters": [
    "text"
  ],
  "verbosity": 1
}

Get the server status

get

Responses

200

Server status

application/json

objectOptional

get

/api/server/status

HTTPcURLJavaScriptPython

GET /api/server/status HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

200

Server status

{}