Skip to main content

Agent

AttributeTypeDetailed OnlyDescription
idstringAgent ID
platformIdstringPlatform of the agent: Windows , Linux
urlstringSelf URL
hoststringHost name/address as specified by user
netbiosNamestringNETBIOS name
authenticationMethodstringThe authentication method for connecting to the agent: Password, PublicKey
agentPortintThe port that is used by the agent. Default: 4498.
userNamestringAccount for connecting to the agent.
passwordstringXAccount password for connecting to the agent. Password is not exposed.
privateKeystringThe private key used when PublicKey authentication method is used. The private key is not exposed.
clientCertificatestringThe agent's client certificate.
protocolstringThe protocol used for connecting to the agent: GRPC
domainstringDomain name of the agent
machineSidstringThe Machine SID of the Agent Server.
osVersionstringOS version or version servicepack
isDCboolIs Agent a domain controller
errorMessagestringDescription of the failure condition
installStatestringState of Activity Monitor agent: NotInstalled, Unknown, Installed, Installing, Upgrading, Uninstalling, Outdated, Failed, ManagedBySI (last one for Threat Prevention agents)
versionstringActivity Monitor agent version
siInstallStatestringState of Threat Prevention agent: NotInstalled, Unknown, Installed, Installing, Upgrading, Uninstalling, Outdated, Failed, ManagedBySI (last one for Threat Prevention agents)
siVersionstringThreat Prevention agent version
managedBySIboolTrue if the Threat Prevention Agent configuration is managed by Threat Prevention. Otherwise Activity Monitor managed the Threat Prevention Agent
configVersionstringA hash of the config file
monitoredHostsUrlstringURL to the list of agent's hosts
monitoredDomainUrlstringURL to the domain monitored by the agent, if any
warningsstring[]XArray of errors/warnings if any
ad.safeModeStatusstringXpending, approved. If pending the Threat Prevention agent in the safe mode.
ad.safeModeMessagestringXIf in the safe mode, contains a reason why the agent switched to the mode.
ad.hardeningIsEnabledboolXAD Module hardening is enabled or disabled.
ad.safeModeIsEnabledboolXAD Module safe mode is enabled or disabled.
ad.dnsResolveIsEnabledboolXAD Module DNS hostname resolution is enabled or disabled.
ad.siIpWhiteliststring[]XWhitelist of IPs allowed to connect to the AD Module port.
archive.IsEnabledboolXWhether the archiving feature is enabled
archive.pathstringXUNC path of the archival location
archive.userNamestringXAn account to access the archival location.
archive.passwordstringXUser password to access the archival location. Password is not exposed.
archive.maxLocalSizestringXMaximum space the agent is allowed to use on the local drives.
fpolicy.portintXNetApp c-mode fpolicy port
fpolicy.authstringXNoAuth, Server, Mutual
fpolicy.ipWhiteliststring[]XIP whitelist
fpolicy.clientCertificatestringXThe Client or CA certificate that is currently set.
fpolicy.serverCertificatestringXThe FPolicy Server certificate that is currently set. Server Certificate is not exposed.
minLocalFreeSpacestringXFree disk threshold after which the agent stops writing data to the log files
cee.vcapsIsEnabledboolXCEE Asynchronous bulk delivery (VCAPS) is enabled or disabled.
cee.vcapsIntervalintXInterval in seconds on how often events are delivered by CEE.
cee.vcapsEventsintXInterval in number of events on how often events are delivered by CEE.
cee.httpEnabledboolXCEE HTTP protocol is enabled or disabled
cee.rpcEnabledboolXCEE RPC protocol is enabled or disabled
cee.ipWhiteliststring[]XWhitelist of IPs that are allowed to connect to the agent via http protocol. If blank the agent will accept connections from any host.
inactivityAlerts.isEnabledboolXWhether Inactivity Alerting is enabled
inactivityAlerts.inactivityIntervalintXThe time interval to elapse after the Monitored Host stops receiving events.
inactivityAlerts.replayIntervalintXHow often to repeat an alert if the inactivity period is long lasting.
inactivityAlerts.inactivityCheckIntervalintXThe time interval to check the Monitored Host for new events.
inactivityAlerts.syslog.serverstringXThe syslog server that is sent inactivity alerts.
inactivityAlerts.syslog.protocolstringXThe syslog server protocol that is used: "UDP" , "TCP" , "TLS"
inactivityAlerts.syslog.separatorstringXThe syslog server separator / message framing that is used: "LF ASCII 10" , "CR ASCII 13" , "CRLF ASCII 13, 10" , "NUL ASCII 0" , "Octet Count RFC 5425". Only used for TCP and TLS protocols.
inactivityAlerts.syslog.templatestringXThe syslog server template text that is used.
inactivityAlerts.email.serverstringXThe email SMTP server that is sent inactivity alerts.
inactivityAlerts.email.sslboolXEmail SMTP Server SSL / TLS is enabled or disabled.
inactivityAlerts.email.userNamestringXEmail SMTP Server Username.
inactivityAlerts.email.passwordstringXEmail SMTP Server Password. Password is not exposed.
inactivityAlerts.email.fromstringXEmail address of where the inactivity alert is from.
inactivityAlerts.email.tostringXEmail address of where the inactivity alert is sent to.
inactivityAlerts.email.subjectstringXEmail message subject of the inactivity alert.
inactivityAlerts.email.bodystringXEmail message body of the inactivity alert.
apiServerIsEnabledboolAPI Server is enabled or disabled
apiServerPortintAPI Server TCP/IP port
apiServerIpWhiteliststring[]XWhitelist of IPs allowed to connect to the API Server port.
apiServerMgmtConsolestringXNETBIOS name of the Console machine that manages the agent list of the API Server (only available for agent(s) that are running the api server)
traceLevelstringXThe logging trace level of the agent.
externalNicNamestringXThe selected network interface that is used for connections. If blank, the agent will auto-detect the network interface to use.
commentstringThe agent's set comment.
etwLogEnabledboolIf true or enabled the windows agent will produce extended debugging data (ETW) logs from the windows driver when Trace logging is enabled for the agent.
linux.serviceUsernamestringXThe linux agent's service username that is used to run the agent service / daemon. If blank, root user is used.
networkProxy.addressstringXHTTP Proxy Server set in SERVER[:PORT] format. If blank HTTP Proxy is disabled.
networkProxy.useDefaultCredentialsboolXIf enabled the proxy server authenticates as the agent's machine account.
networkProxy.bypassProxyOnLocalboolXIf enabled the agent will bypass the proxy server for local addresses.
networkProxy.userNamestringXThe Proxy Server Username
networkProxy.passwordstringXThe Proxy Server Password. Password is not exposed.
networkProxy.bypassListstring[]XList of regular expressions that describe URIs that do not use the proxy server when accessed.
dns.isEnabledboolXLocal DNS caching service is enabled or disabled.
dns.listenPortintXPort used by the DNS caching service.
dns.parallelismintXParallelism level to use while processing DNS requests.
dns.perfStatsTimeDebugTimeSpanXPeriod to dump performance statistics on debug level.
dns.perfStatsTimeInfoTimeSpanXPeriod to dump performance statistics on info level.
dns.forwardDnsServerstring[]XList of DNS servers specified to be used for lookups. If blank, the default DNS servers of the agent are used.
dns.cacheFilestringXThe DNS cache buffer filename that is used.
dns.successTtlTimeSpanXHow long to cache successful lookup results before attempting the search again.
dns.failedTtlTimeSpanXHow long to cache a failed lookup result before attempting the search again.
dns.clientWaitTimeoutTimeSpanXThe amount of the DNS service is allowed to process a request before sending a not found response. If no results are received the lookup operation continues in the background.
dns.refreshThresholdTimeSpanXAn interval between expired items in the cache check.
dns.maxCacheSizeintXThe max size of the dns service buffer file.
dns.uselessAgeTimeSpanXThe DNS service does not resolve names for events older then the set time period.
dns.maxAttemptsToResolveintXMaximum attempts that the DNS service will use to resolve addresses. If 0 is set, the DNS service will resolve addresses infinitely.
dns.suffixstringXThe DNS suffix identifies the domain name that is appended to an unqualified host name to obtain a fully qualified domain name (FQDN) suitable for a dns name query.
adUsers.domainControllersstring[]XList of Domain Controllers to be used for user lookups. If blank, the default behavior is used.
adUsers.lookupTimeoutTimeSpanXThe amount of time the agent will wait for the query results. If no results are received , the agent reports an empty username in the events, but continues the lookup operation in the background.
adUsers.successCacheTtlTimeSpanXHow long to cache successful lookup results before attempting the lookup from Active Directory again.
adUsers.failedCacheTtlTimeSpanXHow long to cache failed lookup results before attempting the lookup from Active Directory again.
adUsers.maxCacheSizeintXThe max size of the cache buffer file.
panzura.portintXAgent port used for Panzura.
panzura.useCredentialsboolXProtection of Panzura port is enabled or disabled.
panzura.usernamestringXPanzura's MQ username used for port protection.
panzura.passwordstringXPanzura's MQ password used for port protection. Password is not exposed.
panzura.ipWhiteliststring[]XWhitelist of IP addresses of Panzura nodes that are allowed to connect to the Agent's Panzura port. If blank, connections from any host are accepted.
nutanix.portintXAgent port used for Nutanix.
nutanix.ipWhiteliststring[]XWhitelist of IP addresses of Nutanix nodes that are allowed to connect to the Agent's Nutanix port. If blank, connections from any host are accepted.
qumulo.portintXAgent port used for Qumulo.
qumulo.ipWhiteliststring[]XWhitelist of IP addresses of Qumulo nodes that are allowed to connect to the Agent's Qumulo port. If blank, connections from any host are accepted.
ctera.portintXAgent port used for Ctera.
ctera.ipWhiteliststring[]XWhitelist of IP addresses of CTERA portals that are allowed to connect to the Agent's CTERA port. If blank, connections from any host are accepted.

Response Example

{
    "warnings": [],
    "archive": {
        "isEnabled": false,
        "path": "\\\\KDVM01\\SBACTIVITYLOGS",
        "userName": "",
        "maxLocalSize": "5GB"
    },
    "cee": {
        "vcapsIsEnabled": false,
        "vcapsInterval": 60,
        "vcapsEvents": 100,
        "httpEnabled": false,
        "rpcEnabled": true,
        "ipWhitelist": []
    },
    "ad": {
        "safeModeStatus": null,
        "safeModeMessage": null,
        "hardeningIsEnabled": false,
        "safeModeIsEnabled": true,
        "dnsResolveIsEnabled": true,
        "siIpWhitelist": []
    },
    "minLocalFreeSpace": "64MB",
    "fpolicy": {
        "port": 9999,
        "auth": "NoAuth",
        "ipWhitelist": [],
        "clientCertificate": "",
        "serverCertificate": ""
    },
    "inactivityAlerts": {
        "isEnabled": false,
        "inactivityInterval": 360,
        "replayInterval": 360,
        "inactivityCheckInterval": 1,
        "syslog": {
            "server": "",
            "protocol": "UDP",
            "separator": "Lf",
            "template": "<14>1 %TIME_STAMP_UTC% %AGENT% %PRODUCT% - NO_DATA - [origin ip=\"%INACTIVE_SERVER_IP%\"][noactivity@33334 host=\"%INACTIVE_SERVER%\" lastEvent=\"%LAST_EVENT_TIME_STAMP_UTC%\" activityType=\"%ACTIVITY_TYPE%\"] No activity events from %INACTIVE_SERVER% for %INACTIVITY_PERIOD_HOURS% hours."
        },
        "email": {
            "server": "",
            "ssl": false,
            "userName": "",
            "from": "",
            "to": "",
            "subject": "[Activity Monitor] No activity events from %INACTIVE_SERVER% for %INACTIVITY_PERIOD_HOURS% hours",
            "body": "There were no activity events from %INACTIVE_SERVER% for %INACTIVITY_PERIOD_HOURS% hours.\n  \nHost:                 %INACTIVE_SERVER%\n  Activity Type: %ACTIVITY_TYPE%\n  Period of inactivity: %INACTIVITY_PERIOD_HOURS% hours / %INACTIVITY_PERIOD_MINUTES% minutes\n  Last event received:  %LAST_EVENT_TIME_STAMP_UTC% (UTC)\n  Last event received:  %LAST_EVENT_TIME_STAMP% (agent time)\n  Agent:                %AGENT%\n  \n  \n  %PRODUCT% %PRODUCT_VERSION%\n"
        }
    },
    "panzura": {
        "port": 4497,
        "useCredentials": false,
        "username": "guest",
        "ipWhitelist": []
    },
    "nutanix": {
        "port": 4501,
        "ipWhitelist": []
    },
    "qumulo": {
        "port": 4496,
        "ipWhitelist": []
    },
    "ctera": {
        "port": 4499,
        "ipWhitelist": []
    },
    "linux": {
        "serviceUsername": ""
    },
    "apiServerIpWhitelist": [],
    "apiServerMgmtConsole": "KDVM01",
    "traceLevel": "Info",
    "externalNicName": "",
    "dns": {
        "isEnabled": false,
        "listenPort": 4503,
        "parallelism": 4,
        "perfStatsTimeDebug": "00:01:00",
        "perfStatsTimeInfo": "00:10:00",
        "forwardDnsServer": [],
        "cacheFile": "dns.cache",
        "successTtl": "01:00:00",
        "failedTtl": "00:01:00",
        "clientWaitTimeout": "00:00:01.8000000",
        "refreshThreshold": "00:00:01",
        "maxCacheSize": 1000000,
        "uselessAge": "1.00:00:00",
        "maxAttemptsToResolve": 30,
        "suffix": ""
    },
    "adUsers": {
        "domainControllers": [],
        "lookupTimeout": "00:00:02",
        "successCacheTtl": "10:00:00",
        "failedCacheTtl": "00:01:00",
        "maxCacheSize": 300000
    },
    "networkProxy": {
        "address": "",
        "useDefaultCredentials": false,
        "bypassProxyOnLocal": false,
        "userName": "",
        "bypassList": []
    },
    "id": "AGENT0",
    "platformId": "windows",
    "url": "https://127.0.0.1:4494/api/v1/agents/AGENT0",
    "host": "KDVM01",
    "netbiosName": "KDVM01",
    "authenticationMethod": "Password",
    "userName": "KDUD1\\Administrator",
    "clientCertificate": "",
    "protocol": "GRPC",
    "domain": "KDUD1",
    "machineSid": "S-1-5-21-3126412784-2087258618-1984987930-1105",
    "osVersion": "10.0.14393.0",
    "isDC": false,
    "errorMessage": "",
    "installState": "Installed",
    "version": "7.1.164",
    "siInstallState": "NotInstalled",
    "siVersion": "",
    "managedBySI": false,
    "configVersion": "xVdvRQnWGvifzQ8Q9rpfVj227Jo=",
    "monitoredHostsUrl": "https://127.0.0.1:4494/api/v1/agents/AGENT0/hosts",
    "monitoredDomainUrl": "https://127.0.0.1:4494/api/v1/agents/AGENT0/domain",
    "apiServerIsEnabled": true,
    "apiServerPort": 4494,
    "comment": "",
    "agentPort": 4498
}

Domain

AttributeTypeDetailed OnlyDescription
idstringDomain ID
urlstringSelf URL
namestringDomain NETBIOS name
managedBySIboolWhether the monitoring configuration is managed by Threat Prevention or Activity Monitor
outputsoutput[]Domain outputs. Domain outputs are common for all the domain controllers. However, there are several agent-specific settings, like archivePath. Do get agent-specific outputs use api/v1/agents/«agentId»/domain.
outputsUrlstringURL to domain outputs
agentsUrlstringURL to domain controllers
masterAgentIdstringID of the Master agent - the one whose configuration is considered the master one.
masterAgentUrlstringURL to the Master agent.
policiespolicy[]Domain Policies. The list of policies for the domain.

Response Example

{
    "id": "KDUD1",
    "url": "https://127.0.0.1:4494/api/v1/domains/KDUD1",
    "name": "KDUD1",
    "managedBySI": false,
    "outputs": [
        {
            "id": "69cce1100fce406192d1d8553083af43",
            "url": "https://127.0.0.1:4494/api/v1/domains/KDUD1/outputs/69cce1100fce406192d1d8553083af43",
            "domainId": "KDUD1",
            "domainUrl": "https://127.0.0.1:4494/api/v1/domains/KDUD1",
            "agentsIds": [],
            "isEnabled": true,
            "type": "LogFile",
            "logFile": {
                "format": "Json",
                "path": "C:\\ProgramData\\Netwrix\\Activity Monitor\\Agent\\ActivityLogs\\KDUD1_Log_.json",
                "archivePath": "\\\\KDVM01\\SBACTIVITYLOGS\\KDDC01\\KDUD1_69cce110-0fce-4061-92d1-d8553083af43\\KDUD1_Log_.json",
                "periodToRetainLog": 10,
                "reportUserName": false,
                "reportUncPath": false,
                "addCToPath": true,
                "reportMilliseconds": true,
                "stealthAudit": true
            },
            "comment": "",
            "managedBy": "",
            "altHost": ""
        },
        {
            "id": "cd34eb7a0c1d40c097b56056af2afd73",
            "url": "https://127.0.0.1:4494/api/v1/domains/KDUD1/outputs/cd34eb7a0c1d40c097b56056af2afd73",
            "domainId": "KDUD1",
            "domainUrl": "https://127.0.0.1:4494/api/v1/domains/KDUD1",
            "agentsIds": [],
            "isEnabled": true,
            "type": "Syslog",
            "syslog": {
                "reportUncPath": false,
                "addCToPath": true,
                "server": "1.2.3.4:514",
                "protocol": "UDP",
                "separator": "Lf",
                "template": "%SYSLOG_DATE% %HOST% LEEF:1.0|%COMPANY%|%PRODUCT%|%PRODUCT_VERSION%|%EVENT_SOURCE_TYPE%%CLASS_NAME%%EVENTNAMETRANSLATED%%SUCCESS%%BLOCKED_EVENT%|cat=%EVENTNAMETRANSLATED%\tdevTimeFormat=yyyy-MM-dd HH:mm:ss.SSS\tdevTime=%TIME_STAMP%\tSettingName=%SETTING_NAME%\tdomain=%EVENT_SOURCE_NAME%\tusrName=%PERPETRATOR_NAME%\tsrc=%ORIGINATINGCLIENTIP%\tdst=%ORIGINATING_SERVERIP%\tDistinguishedName=%DN%\tAffectedObject=%AFFECTED_OBJECT_ACCOUNT_NAME%\tClassName=%CLASS_NAME%\tOrigServer=%ORIGINATING_SERVER%\tSuccess=%SUCCESS%\tBlocked=%BLOCKED_EVENT%\tAttrName=%ATTRIBUTE_NAME%\tAttrNewValue=%ATTRIBUTE_VALUE%\tAttrOldValue=%OLD_ATTRIBUTE_VALUE%\tOperation=%OPERATION%"
            },
            "comment": "",
            "managedBy": "",
            "altHost": ""
        },
        {
            "id": "bee61b424f214f7583e9cece222b8f41",
            "url": "https://127.0.0.1:4494/api/v1/domains/KDUD1/outputs/bee61b424f214f7583e9cece222b8f41",
            "domainId": "KDUD1",
            "domainUrl": "https://127.0.0.1:4494/api/v1/domains/KDUD1",
            "agentsIds": [],
            "isEnabled": true,
            "type": "Amqp",
            "amqp": {
                "server": "5.6.7.8:10001",
                "userName": "StealthINTERCEPT",
                "queue": "",
                "exchange": "StealthINTERCEPT",
                "vhost": ""
            },
            "comment": "",
            "managedBy": "",
            "altHost": ""
        }
    ],
    "outputsUrl": "https://127.0.0.1:4494/api/v1/domains/KDUD1/outputs",
    "agentsUrl": "https://127.0.0.1:4494/api/v1/domains/KDUD1/agents",
    "masterAgentId": "AGENT1",
    "masterAgentUrl": "https://127.0.0.1:4494/api/v1/agents/AGENT1"
}

Host

AttributeTypeDetailed OnlyDescription
idstringID of the host.
urlstringSelf URL
hoststringHost name/Address as specified by a user
typestringWindows,NetApp,Celerra,Isilon,Hitachi,SharePoint,Unity,Nasuni, Panzura, SharePointOnline, AzureAD, Linux, SqlServer
userNamestringAn account to connect the host to
passwordstringXAccount password to connect the host to. Password is not exposed.
autoConfigureAuditingboolAutomatically enable the auditing on the device, if supported
monitorAuditingStatusboolConstantly verify that the auditing is enabled, fix if needed
hostAliasesstring[]List of server names for NAS if they are different from the set name of the host.
outputsoutput[]Array of host's outputs
inactivityAlerts.isEnabledboolWhether Inactivity Alerting is enabled
inactivityAlerts.useCustomSettingsboolWhether to use custom host settings, or inherit from agent settings.
inactivityAlerts.inactivityIntervalintThe time interval to elapse after the Monitored Host stops receiving events.
inactivityAlerts.replayIntervalintHow often to repeat an alert if the inactivity period is long lasting.
inactivityAlerts.inactivityCheckIntervalintThe time interval to check the Monitored Host for new events.
inactivityAlerts.syslog.serverstringThe syslog server that is sent inactivity alerts.
inactivityAlerts.syslog.protocolstringThe syslog protocol that is used: "UDP" , "TCP" , "TLS"
inactivityAlerts.syslog.separatorstringThe syslog server separator / message framing that is used: "LF ASCII 10" , "CR ASCII 13" , "CRLF ASCII 13, 10" , "NUL ASCII 0" , "Octet Count RFC 5425". Only used for TCP and TLS protocols.
inactivityAlerts.syslog.templatestringThe syslog message template text.
inactivityAlerts.email.serverstringThe email or SMTP server or IP that is used to send host inactivity alerts.
inactivityAlerts.email.sslboolEmail SMTP Server SSL / TLS is enabled or disabled.
inactivityAlerts.email.userNamestringThe email or SMTP server user name.
inactivityAlerts.email.passwordstringXThe email or SMTP server password. Password is not exposed.
inactivityAlerts.email.fromstringEmail address of where the inactivity alert is from.
inactivityAlerts.email.tostringEmail address of where the inactivity alert is sent to.
inactivityAlerts.email.subjectstringEmail message subject of the inactivity alert.
inactivityAlerts.email.bodystringEmail message body of the inactivity alert.
uidTranslate.isEnabledboolNFS UID translation to Windows SID is enabled or disabled.
uidTranslate.domainControllerstringThe name of the forest or a Domain Controller. Used for Active Directory searches.
uidTranslate.portintThe port used for Active Directory searches.
uidTranslate.optionsstringThe set options used for Active Directory searches.
uidTranslate.containerstringThe Active Directory container set to be searched.
uidTranslate.scopestringThe scope of the Active Directory search.
uidTranslate.filterstringThe filter of the Active Directory search.
hitachi.uncLogPathstringThe path of the hitachi audit event log file.
hitachi.logFileNamestringThe filename of the hitachi audit event log.
hitachi.pollingIntervalTimeSpanThe interval of polling the log for new events.
api.protocolstringThe API Protocol being used: "AutoDetect", "HTTPS", "HTTPSIgnoreErrors", "HTTP".
api.certificatestringThe text output of the HTTPS certificate.
api.hostNameVerificationboolIf certificate hostname verification is enabled or disabled.
api.channelstringThe communication method being used: "AutoDetect", "ONTAPI", "REST" (only used for netapp hosts)
netapp.managementLifstringThe Management LIF of the netapp host. Disabled / Empty by default.
netapp.nfs3EventNamestringThe fpolicy Event Name for successful NFSv3 Events. Default: "StealthAUDITScreeningNfsV3"
netapp.nfs3FailedEventNamestringThe fpolicy Event Name for failed NFSv3 Events. Default: "StealthAUDITScreeningFailedNfsV3"
netapp.nfs4FailedEventNamestringThe fpolicy Event Name for failed NFSv4 Events. Deafult: "StealthAUDITScreeningFailedNfsV4"
netapp.nfs4EventNamestringThe fpolicy Event Name for successful NFSv4 Events. Default: "StealthAUDITScreeningNfsV4"
netapp.cifsEventNamestringThe fpolicy Event Name for successful CIFS Events. Default: "StealthAUDITScreeningCifs"
netapp.cifsFailedEventNamestringThe fpolicy Event Name for failed CIFS Events. Default: "StealthAUDITScreeningCifs"
netapp.policyNamestringThe fpolicy Policy Name used for the Activity Monitor. Default: "StealthAUDIT"
netapp.externalEngineNamestringThe fpolicy External Engine Name used for the Activity Monitor. Default: "StealthAUDITEngine"
sharePoint.pollingIntervalTimeSpanThe polling interval set for sharepoint on premise hosts.
spo.azure.domainstringThe Azure Active Directory domain being monitored for SharePoint Online.
spo.azure.azureCloudstringThe selected Azure Cloud being used: "Azure", "Azure for US Government GCC", "Azure for Government GCC High", "Azure for US Government DoD", "Azure Germany", "Azure China by 21Vianet"
spo.azure.tenantIdstringThe azure Tenant ID
spo.azure.tenantNamestringThe azure Tenant Name
spo.azure.clientIdstringThe azure Tenant Client ID.
spo.azure.clientSecretstringXThe azure Client Secret. Client Secret is not exposed.
spo.azure.regionstringThe azure Region.
azureAd.azure.domainstringThe Azure Active Directory domain being monitored.
azureAd.azure.azureCloudstringThe selected Azure Cloud being used: "Azure", "Azure for US Government GCC", "Azure for Government GCC High", "Azure for US Government DoD", "Azure Germany", "Azure China by 21Vianet"
azureAd.azure.tenantIdstringThe azure Tenant ID
azureAd.azure.tenantNamestringThe azure Tenant Name
azureAd.azure.clientIdstringThe azure Tenant Client ID.
azureAd.azure.clientSecretstringXThe azure Client Secret. Client Secret is not exposed.
azureAd.azure.regionstringThe azure Region.
exchangeOnline.azure.domainstringThe Azure Active Directory domain being monitored for Exchange Online.
exchangeOnline.azure.azureCloudstringThe selected Azure Cloud being used: "Azure", "Azure for US Government GCC", "Azure for Government GCC High", "Azure for US Government DoD", "Azure Germany", "Azure China by 21Vianet"
exchangeOnline.azure.tenantIdstringThe azure Tenant ID
exchangeOnline.azure.tenantNamestringThe azure Tenant Name
exchangeOnline.azure.clientIdstringThe azure Tenant Client ID.
exchangeOnline.azure.clientSecretstringXThe azure Client Secret. Client Secret is not exposed.
exchangeOnline.azure.regionstringThe azure Region.
sql.pollingIntervalstringThe interval for polling SQL log for new events.
sql.tweakOptionsstring[]Extended Events tweaking options for SQL hosts.
outputsUrlstringURL to the host's outputs
agentsUrlstringURL to the agents that are monitoring the host
status.updatedAtDateTimeA timestamp when the status has changed to this value.
status.typestringOK, Error, or Warning - indicates a type of the status.
status.summarystringA user-friendly summary string of the status. May be empty for the OK type, non-empty otherwise.
status.detailsstringA user-friendly message that describes the status. May be empty.
statusHistoryUrlstringURL to the status history of the host.
stats.receivedAtDateTimeTimestamp indicating the last time the Agent received something from the Host.
stats.receivedCountlongTotal number of events received by the agent for the Host.
stats.lastEventTimeDateTimeThe most recent timestamp among all recent events received for the Host. File servers and other event sources can deliver events out of order. For example, each node of PowerScale cluster has its log and delivery cadence. This field shows the MAX(timestamp) for recent events.

Response Example

{
    "autoConfigureAuditing": false,
    "monitorAuditingStatus": false,
    "hostAliases": [],
    "inactivityAlerts": {
        "isEnabled": false,
        "useCustomSettings": false,
        "inactivityInterval": 360,
        "replayInterval": 360,
        "inactivityCheckInterval": 1,
        "syslog": {
            "server": "",
            "protocol": "UDP",
            "separator": "Lf",
            "template": "<14>1 %TIME_STAMP_UTC% %AGENT% %PRODUCT% - NO_DATA - [origin ip=\"%INACTIVE_SERVER_IP%\"][noactivity@33334 host=\"%INACTIVE_SERVER%\" lastEvent=\"%LAST_EVENT_TIME_STAMP_UTC%\" activityType=\"%ACTIVITY_TYPE%\"] No activity events from %INACTIVE_SERVER% for %INACTIVITY_PERIOD_HOURS% hours."
        },
        "email": {
            "server": "",
            "ssl": false,
            "userName": "",
            "from": "",
            "to": "",
            "subject": "[Activity Monitor] No activity events from %INACTIVE_SERVER% for %INACTIVITY_PERIOD_HOURS% hours",
            "body": "There were no activity events from %INACTIVE_SERVER% for %INACTIVITY_PERIOD_HOURS% hours.\n  \nHost:                 %INACTIVE_SERVER%\n  Activity Type: %ACTIVITY_TYPE%\n  Period of inactivity: %INACTIVITY_PERIOD_HOURS% hours / %INACTIVITY_PERIOD_MINUTES% minutes\n  Last event received:  %LAST_EVENT_TIME_STAMP_UTC% (UTC)\n  Last event received:  %LAST_EVENT_TIME_STAMP% (agent time)\n  Agent:                %AGENT%\n  \n  \n  %PRODUCT% %PRODUCT_VERSION%\n"
        }
    },
    "id": "Windows-kdvm01",
    "url": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm01",
    "host": "KDVM01",
    "type": "Windows",
    "userName": "",
    "outputs": [
        {
            "id": "b08e3c84905b4aed8718f42d2ecc523d",
            "url": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm01/outputs/b08e3c84905b4aed8718f42d2ecc523d",
            "hostId": "Windows-kdvm01",
            "hostUrl": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm01",
            "agentsIds": [
                "AGENT0"
            ],
            "logsUrl": "https://127.0.0.1:4494/api/v1/logs/b08e3c84905b4aed8718f42d2ecc523d",
            "isEnabled": true,
            "type": "LogFile",
            "logFile": {
                "format": "Tsv",
                "path": "C:\\ProgramData\\Netwrix\\Activity Monitor\\Agent\\ActivityLogs\\KDVM01_Log_.tsv",
                "archivePath": "",
                "periodToRetainLog": 10,
                "reportUserName": false,
                "reportUncPath": false,
                "addCToPath": true,
                "reportMilliseconds": true,
                "stealthAudit": true
            },
            "fileFilter": {
                "allowed": true,
                "denied": true,
                "cifs": true,
                "nfs": true,
                "read": true,
                "dirRead": false,
                "create": true,
                "dirCreate": true,
                "rename": true,
                "dirRename": true,
                "delete": true,
                "dirDelete": true,
                "update": true,
                "permission": true,
                "dirPermission": true,
                "attribute": true,
                "dirAttribute": true,
                "readOptimize": false,
                "shareAdd": false,
                "shareDelete": false,
                "shareUpdate": false,
                "sharePermission": false,
                "streamRead": true,
                "streamUpdate": true,
                "streamDelete": true,
                "streamAdd": true,
                "includePaths": [],
                "excludePaths": [],
                "excludeExtensions": [
                    ".TMP",
                    ".RCV",
                    ".DS_STORE",
                    ".POLICY",
                    ".MANIFEST",
                    ".LACCDB",
                    ".LDB"
                ],
                "excludeProcesses": [
                    "SBTService.exe",
                    "FPolicyServerSvc.exe",
                    "CelerraServerSvc.exe",
                    "FSACLoggingSvc.exe",
                    "HitachiService.exe",
                    "SIWindowsAgent.exe",
                    "SIGPOAgent.exe",
                    "LogProcessorSrv.exe",
                    "SearchIndexer.exe",
                    "WindowsSearch.exe",
                    "StealthAUDIT",
                    "MonitorService35.exe",
                    "MonitorService40.exe",
                    "MonitorService45.exe",
                    "Configuration.exe",
                    "ConfigurationAgent.exe",
                    "ConfigurationAgent.Grpc.Host.exe"
                ],
                "excludeReadProcesses": [],
                "excludeAccounts": [
                    "S-1-5-17",
                    "S-1-5-18",
                    "S-1-5-19",
                    "S-1-5-20"
                ],
                "filterGroups": false,
                "officeFiltering": false,
                "pathFilters": [
                    "-**\\~$*.DOC",
                    "-**\\~$*.DOCX",
                    "-**\\~$*.ODT",
                    "-**\\~$*.PPT",
                    "-**\\~$*.PPTX",
                    "-**\\~$*.PUB",
                    "-**\\~$*.RTF",
                    "-**\\~$*.TXT",
                    "-**\\~$*.WPS",
                    "-**\\~$*.XLSX",
                    "-**\\~$*.XSN",
                    "-**\\~$*.XML",
                    "-**\\~$*.DOCM",
                    "-**\\~$*.DOTX",
                    "-**\\~$*.DOTM",
                    "-**\\~$*.DOT",
                    "-**\\~$*.MHT",
                    "-**\\~$*.HTM",
                    "-**\\~$*.XLSM",
                    "-**\\~$*.XLSB",
                    "-**\\~$*.XLTX",
                    "-**\\~$*.XLTM",
                    "-**\\~$*.XLAM",
                    "-**\\~$*.ODS",
                    "-**\\~$*.PPTM",
                    "-**\\~$*.POTX",
                    "-**\\~$*.POTM",
                    "-**\\~$*.POT",
                    "-**\\~$*.THMX",
                    "-**\\~$*.PPSX",
                    "-**\\~$*.PPSM",
                    "-**\\~$*.PPS",
                    "-**\\~$*.ODP",
                    "-**\\~$*.PDF",
                    "-**\\~$*.XPS",
                    "-**\\.TEMPORARYITEMS\\**",
                    "-**\\~SNAPSHOT\\**",
                    "-**\\WATSONRC.DAT",
                    "-**\\DESKTOP.INI",
                    "-C:\\Windows\\**",
                    "-C:\\Program Files\\**",
                    "-C:\\Program Files (x86)\\**",
                    "-C:\\ProgramData\\**",
                    "-C:\\Documents and Settings\\**",
                    "-C:\\Users\\**"
                ],
                "discardPreviewSubfolderReads": true,
                "discardPreviewSubfolderReadsInterval": 10,
                "discardPreviewFileReads": false,
                "discardPreviewFileReadsInterval": 60,
                "discardPreviewFileReadsFilenames": [
                    "*.exe",
                    "*.url",
                    "*.lnk"
                ],
                "duplicateReadsInterval": 60
            },
            "comment": "",
            "managedBy": "",
            "windows": {
                "vssCreation": true,
                "vssDeletion": true,
                "vssActivity": true,
                "discardReorderedAcl": true,
                "discardInheritedAcl": false
            },
            "status": {
                "updatedAt": "2024-09-16T17:32:24.9987211Z",
                "type": "OK"
            },
            "statusHistoryUrl": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm01/outputs/b08e3c84905b4aed8718f42d2ecc523d/statusHistory",
            "altHost": "",
            "stats": {
                "reportedAt": "2024-09-16T16:33:13.803Z",
                "reportedCount": 0,
                "lastEventTime": "2024-09-16T16:33:13.803Z",
                "filesCount": 2,
                "filesSize": 1440,
                "archiveFilesCount": 0,
                "archiveFilesSize": 0
            }
        },
        {
            "id": "f20aa0a8b7de4961b8ea9016b0d5d579",
            "url": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm01/outputs/f20aa0a8b7de4961b8ea9016b0d5d579",
            "hostId": "Windows-kdvm01",
            "hostUrl": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm01",
            "agentsIds": [
                "AGENT0"
            ],
            "isEnabled": true,
            "type": "Syslog",
            "syslog": {
                "reportUncPath": false,
                "addCToPath": true,
                "server": "192.168.2.1:514",
                "protocol": "UDP",
                "separator": "Lf",
                "template": "%SYSLOG_DATE% %HOST% LEEF:1.0|%COMPANY%|%PRODUCT%|%PRODUCT_VERSION%|%EVENT_SOURCE_TYPE%%CLASS_NAME%%EVENT_NAME%%SUCCESS%%BLOCKED_EVENT%|cat=%EVENT_NAME%\tdevTimeFormat=yyyy-MM-dd HH:mm:ss.SSS\tdevTime=%TIME_STAMP%\tSettingName=%SETTING_NAME%\tdomain=%EVENT_SOURCE_NAME%\tusrName=%PERPETRATOR%\tsrc=%ORIGINATING_CLIENT_IP%\tdst=%ORIGINATING_SERVER_IP%\tDistinguishedName=%FILE_PATH%\tAffectedObject=\tClassName=%CLASS_NAME%\tOrigServer=%ORIGINATING_SERVER%\tSuccess=%SUCCESS%\tBlocked=%BLOCKED_EVENT%\tAttrName=%ATTRIBUTE_NAME%\tAttrNewValue=%ATTRIBUTE_VALUE%\tAttrOldValue=%OLD_ATTRIBUTE_VALUE%\tOperation=%OPERATION%"
            },
            "fileFilter": {
                "allowed": true,
                "denied": true,
                "cifs": true,
                "nfs": true,
                "read": true,
                "dirRead": false,
                "create": true,
                "dirCreate": true,
                "rename": true,
                "dirRename": true,
                "delete": true,
                "dirDelete": true,
                "update": true,
                "permission": true,
                "dirPermission": true,
                "attribute": true,
                "dirAttribute": true,
                "readOptimize": false,
                "shareAdd": false,
                "shareDelete": false,
                "shareUpdate": false,
                "sharePermission": false,
                "streamRead": true,
                "streamUpdate": true,
                "streamDelete": true,
                "streamAdd": true,
                "includePaths": [],
                "excludePaths": [],
                "excludeExtensions": [
                    ".TMP",
                    ".RCV",
                    ".DS_STORE",
                    ".POLICY",
                    ".MANIFEST",
                    ".LACCDB",
                    ".LDB"
                ],
                "excludeProcesses": [
                    "SBTService.exe",
                    "FPolicyServerSvc.exe",
                    "CelerraServerSvc.exe",
                    "FSACLoggingSvc.exe",
                    "HitachiService.exe",
                    "SIWindowsAgent.exe",
                    "SIGPOAgent.exe",
                    "LogProcessorSrv.exe",
                    "SearchIndexer.exe",
                    "WindowsSearch.exe",
                    "StealthAUDIT",
                    "MonitorService35.exe",
                    "MonitorService40.exe",
                    "MonitorService45.exe",
                    "Configuration.exe",
                    "ConfigurationAgent.exe",
                    "ConfigurationAgent.Grpc.Host.exe"
                ],
                "excludeReadProcesses": [],
                "excludeAccounts": [
                    "S-1-5-17",
                    "S-1-5-18",
                    "S-1-5-19",
                    "S-1-5-20"
                ],
                "filterGroups": false,
                "officeFiltering": false,
                "pathFilters": [
                    "-**\\~$*.DOC",
                    "-**\\~$*.DOCX",
                    "-**\\~$*.ODT",
                    "-**\\~$*.PPT",
                    "-**\\~$*.PPTX",
                    "-**\\~$*.PUB",
                    "-**\\~$*.RTF",
                    "-**\\~$*.TXT",
                    "-**\\~$*.WPS",
                    "-**\\~$*.XLSX",
                    "-**\\~$*.XSN",
                    "-**\\~$*.XML",
                    "-**\\~$*.DOCM",
                    "-**\\~$*.DOTX",
                    "-**\\~$*.DOTM",
                    "-**\\~$*.DOT",
                    "-**\\~$*.MHT",
                    "-**\\~$*.HTM",
                    "-**\\~$*.XLSM",
                    "-**\\~$*.XLSB",
                    "-**\\~$*.XLTX",
                    "-**\\~$*.XLTM",
                    "-**\\~$*.XLAM",
                    "-**\\~$*.ODS",
                    "-**\\~$*.PPTM",
                    "-**\\~$*.POTX",
                    "-**\\~$*.POTM",
                    "-**\\~$*.POT",
                    "-**\\~$*.THMX",
                    "-**\\~$*.PPSX",
                    "-**\\~$*.PPSM",
                    "-**\\~$*.PPS",
                    "-**\\~$*.ODP",
                    "-**\\~$*.PDF",
                    "-**\\~$*.XPS",
                    "-**\\.TEMPORARYITEMS\\**",
                    "-**\\~SNAPSHOT\\**",
                    "-**\\WATSONRC.DAT",
                    "-**\\DESKTOP.INI",
                    "-C:\\Windows\\**",
                    "-C:\\Program Files\\**",
                    "-C:\\Program Files (x86)\\**",
                    "-C:\\ProgramData\\**",
                    "-C:\\Documents and Settings\\**",
                    "-C:\\Users\\**"
                ],
                "discardPreviewSubfolderReads": true,
                "discardPreviewSubfolderReadsInterval": 10,
                "discardPreviewFileReads": false,
                "discardPreviewFileReadsInterval": 60,
                "discardPreviewFileReadsFilenames": [
                    "*.exe",
                    "*.url",
                    "*.lnk"
                ],
                "duplicateReadsInterval": 60
            },
            "comment": "",
            "managedBy": "",
            "windows": {
                "vssCreation": true,
                "vssDeletion": true,
                "vssActivity": true,
                "discardReorderedAcl": true,
                "discardInheritedAcl": false
            },
            "status": {
                "updatedAt": "2024-09-16T17:32:24.9987211Z",
                "type": "OK"
            },
            "statusHistoryUrl": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm01/outputs/f20aa0a8b7de4961b8ea9016b0d5d579/statusHistory",
            "altHost": "",
            "stats": {
                "reportedCount": 0
            }
        }
    ],
    "outputsUrl": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm01/outputs",
    "agentsUrl": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm01/agents",
    "status": {
        "updatedAt": "2024-09-16T17:32:24.9987211Z",
        "type": "OK"
    },
    "statusHistoryUrl": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm01/statusHistory",
    "stats": {
        "receivedCount": 0,
        "lastEventTime": "2024-09-16T16:33:13.803Z"
    }
}

Output

AttributeTypeDetailed OnlyDescription
idstringID of the output.
urlstringSelf URL
hostIdstringID of the host that owns the output.
hostUrlstringURL of the host that owns the output.
agentsIdsstring[]List of Agent IDs of the agents managing the output.
domainIdstringAD only: ID of the owning domain
domainUrlstringAD only: Link to the owning domain
logsUrlstringLink to the file output log files (for the local agent only, that has the API Server running)
isEnabledboolWhether or not the output is enabled. If disabled, no activity is forwarded to it.
typestringLogFile,Syslog,Amqp
logFileFileOutputLog file settings
syslogSyslogOutputSyslog settings
amqpAmqpOutputAMQP/DEFEND settings
fileFilterFileFilterFiltering settings for file activity
sharePointFilterSharePointFilterFiltering settings for SharePoint
commentstringUser's comment
managedBystringName of a product that manages this output, if not self managed by NAM Agent. Values: StealthINTERCEPT
windowsWindowsOptionsWindows filtering settings
status.updatedAtDateTimeA timestamp when the status has changed to this value.
status.typestringOK, Error, or Warning - indicates a type of the status.
status.summarystringA user-friendly summary string of the status. May be empty for the OK type, non-empty otherwise.
status.detailsstringA user-friendly message that describes the status. May be empty.
statusHistoryUrlstringURL of the output's status history.
altHoststringA hostname that is reported in the activity events instead of the real hostname.
stats.reportedAtDateTimeTimestamp indicating the last time when an event was reported to the Output.
stats.reportedCountlongTotal number of events reported to the Output.
stats.lastEventTimeDateTimeThe most recent timestamp among all reported events to the Output.
stats.filesCountintNumber of log files on the agent's server.
stats.filesSizelongTotal size of log files on the agent's server.
stats.archiveFilesCountintNumber of log files in the archival location.
stats.archiveFilesSizelongTotal size of log files in the archival location.
stats.archiveLastEventTimeDateTimeThe most recent timestamp in the recently archived log file.

FileOutput

AttributeTypeDetailed OnlyDescription
formatstringTsv, Json
pathstringLog file path on the agent's drive. Timestamp is added before the extension.
archivePathstringLog file path in the archival location (UNC path)
periodToRetainLogintNumber of days to keep the log files alive both on the local drive and in the archive
reportUserNameboolResolve and report user name
reportUncPathboolReport UNC paths in addition to local/native paths
addCToPathboolPrepend the path C:\ and change the forward slashes to backslashes.
reportMillisecondsboolReport events' time with milliseconds
stealthAuditboolThe file was marked for consumption by Access Analyzer

SyslogOutput

AttributeTypeDetailed OnlyDescription
serverstringHostname/address of the syslog server in the format HOST:PORT.
protocolstringUDP, TCP, TLS
separatorstringLf,Cr, CrLf, Nul, Rfc5425
reportUncPathboolReport UNC paths in addition to local/native paths
addCToPathboolPrepend the path C:\ and change the forward slashes to backslashes.
templatestringText of the syslog template that is currently set to be used.

AmqpOutput

AttributeTypeDetailed OnlyDescription
serverstringHostname/address of the AMQP server or the Threat Manager server and the port in the SERVER:PORT format
userNamestringUser name for the AMQP connection, if needed. ForThreat Managerintegration, use an empty string.
passwordstringPassword / App Token for the AMQP connection. Password / App Token is not exposed.
queuestringMessage queue name to post events to. ForThreat Manager integration, use an empty string.
exchangestringExchange name to post events to. ForThreat Manager integration, use "StealthINTERCEPT" for domain outputs or "AM" for host outputs.
vhoststringVirtual Host name, if needed. ForThreat Managerintegration, use an empty string.

FileFilter

AttributeTypeDetailed OnlyDescription
allowedbool
deniedbool
cifsbool
nfsbool
readbool
dirReadbool
createbool
dirCreatebool
renamebool
dirRenamebool
deletebool
dirDeletebool
updatebool
permissionbool
dirPermissionbool
attributebool
dirAttributebool
readOptimizeboolSuppress subsequent read operations in the same folder, by the same user.
shareAddbool
shareDeletebool
shareUpdatebool
sharePermissionbool
streamReadboolReads of Alternate Data Streams.
streamUpdateboolUpdates of Alternate Data Streams.
streamDeleteboolDeletes of Alternate Data Streams.
streamAddboolAdds of Alternate Data Streams.
includePathsstring[]Depreciated. This has been replaced by 'pathFilters'.
excludePathsstring[]Depreciated. This has been replaced by 'pathFilters'.
excludeExtensionsstring[]
excludeProcessesstring[]
excludeReadProccessesstring[]
excludeAccountsstring[]
filterGroupsboolProcess group membership when filtering.
officeFilteringboolSuppress Microsoft Office and other applications operations on temporary files.
pathFiltersstring[]List of paths to include and exclude.
discardPreviewSubfolderReadsbool
discardPreviewSubfolderReadsIntervalint
discardPreviewFileReadsbool
discardPreviewFileReadsIntervalint
discardPreviewFileReadsFilenamesstring[]
duplicateReadsIntervalint

SharePointFilter

AttributeTypeDetailed OnlyDescription
operationsstring[]
includeUrlsstring[]
excludeUrlsstring[]
excludeAccountsstring[]

WindowsOptions

AttributeTypeDetailed OnlyDescription
vssCreationbool
vssDeletionbool
vssActivitybool
discardReorderedAclbool
discardInheritedAclbool

Response Example

{
    "id": "fcf4ad5d951548f0af10a8909c9cc284",
    "url": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm02/outputs/fcf4ad5d951548f0af10a8909c9cc284",
    "hostId": "Windows-kdvm02",
    "hostUrl": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm02",
    "agentsIds": [
        "AGENT2"
    ],
    "isEnabled": false,
    "type": "LogFile",
    "logFile": {
        "format": "Tsv",
        "path": "C:\\ProgramData\\Netwrix\\Activity Monitor\\Agent\\ActivityLogs\\KDVM02_Log_.tsv",
        "archivePath": "",
        "periodToRetainLog": 10,
        "reportUserName": false,
        "reportUncPath": false,
        "addCToPath": true,
        "reportMilliseconds": true,
        "stealthAudit": true
    },
    "fileFilter": {
        "allowed": true,
        "denied": true,
        "cifs": true,
        "nfs": true,
        "read": true,
        "dirRead": false,
        "create": true,
        "dirCreate": true,
        "rename": true,
        "dirRename": true,
        "delete": true,
        "dirDelete": true,
        "update": true,
        "permission": true,
        "dirPermission": true,
        "attribute": true,
        "dirAttribute": true,
        "readOptimize": false,
        "shareAdd": false,
        "shareDelete": false,
        "shareUpdate": false,
        "sharePermission": false,
        "streamRead": true,
        "streamUpdate": true,
        "streamDelete": true,
        "streamAdd": true,
        "includePaths": [],
        "excludePaths": [],
        "excludeExtensions": [
            ".TMP",
            ".RCV",
            ".DS_STORE",
            ".POLICY",
            ".MANIFEST",
            ".LACCDB",
            ".LDB"
        ],
        "excludeProcesses": [
            "SBTService.exe",
            "FPolicyServerSvc.exe",
            "CelerraServerSvc.exe",
            "FSACLoggingSvc.exe",
            "HitachiService.exe",
            "SIWindowsAgent.exe",
            "SIGPOAgent.exe",
            "LogProcessorSrv.exe",
            "SearchIndexer.exe",
            "WindowsSearch.exe",
            "StealthAUDIT",
            "MonitorService35.exe",
            "MonitorService40.exe",
            "MonitorService45.exe",
            "Configuration.exe",
            "ConfigurationAgent.exe",
            "ConfigurationAgent.Grpc.Host.exe"
        ],
        "excludeReadProcesses": [],
        "excludeAccounts": [
            "S-1-5-17",
            "S-1-5-18",
            "S-1-5-19",
            "S-1-5-20"
        ],
        "filterGroups": false,
        "officeFiltering": false,
        "pathFilters": [
            "-**\\~$*.DOC",
            "-**\\~$*.DOCX",
            "-**\\~$*.ODT",
            "-**\\~$*.PPT",
            "-**\\~$*.PPTX",
            "-**\\~$*.PUB",
            "-**\\~$*.RTF",
            "-**\\~$*.TXT",
            "-**\\~$*.WPS",
            "-**\\~$*.XLSX",
            "-**\\~$*.XSN",
            "-**\\~$*.XML",
            "-**\\~$*.DOCM",
            "-**\\~$*.DOTX",
            "-**\\~$*.DOTM",
            "-**\\~$*.DOT",
            "-**\\~$*.MHT",
            "-**\\~$*.HTM",
            "-**\\~$*.XLSM",
            "-**\\~$*.XLSB",
            "-**\\~$*.XLTX",
            "-**\\~$*.XLTM",
            "-**\\~$*.XLAM",
            "-**\\~$*.ODS",
            "-**\\~$*.PPTM",
            "-**\\~$*.POTX",
            "-**\\~$*.POTM",
            "-**\\~$*.POT",
            "-**\\~$*.THMX",
            "-**\\~$*.PPSX",
            "-**\\~$*.PPSM",
            "-**\\~$*.PPS",
            "-**\\~$*.ODP",
            "-**\\~$*.PDF",
            "-**\\~$*.XPS",
            "-**\\.TEMPORARYITEMS\\**",
            "-**\\~SNAPSHOT\\**",
            "-**\\WATSONRC.DAT",
            "-**\\DESKTOP.INI",
            "-C:\\Windows\\**",
            "-C:\\Program Files\\**",
            "-C:\\Program Files (x86)\\**",
            "-C:\\ProgramData\\**",
            "-C:\\Documents and Settings\\**",
            "-C:\\Users\\**"
        ],
        "discardPreviewSubfolderReads": true,
        "discardPreviewSubfolderReadsInterval": 10,
        "discardPreviewFileReads": false,
        "discardPreviewFileReadsInterval": 60,
        "discardPreviewFileReadsFilenames": [
            "*.exe",
            "*.url",
            "*.lnk"
        ],
        "duplicateReadsInterval": 60
    },
    "comment": "",
    "managedBy": "",
    "windows": {
        "vssCreation": true,
        "vssDeletion": true,
        "vssActivity": true,
        "discardReorderedAcl": true,
        "discardInheritedAcl": false
    },
    "status": {
        "updatedAt": "2024-10-01T18:46:00.6768171Z",
        "type": "OK",
        "summary": "OK",
        "details": "OK"
    },
    "statusHistoryUrl": "https://127.0.0.1:4494/api/v1/hosts/Windows-kdvm02/outputs/fcf4ad5d951548f0af10a8909c9cc284/statusHistory",
    "altHost": "",
    "stats": {
        "reportedAt": "2024-09-30T18:49:12.282Z",
        "reportedCount": 12,
        "lastEventTime": "2024-09-30T18:49:12.282Z",
        "filesCount": 1,
        "filesSize": 2204,
        "archiveFilesCount": 0,
        "archiveFilesSize": 0
    }
}

File

AttributeTypeDetailed OnlyDescription
idstringActivity Log File ID.
sizeintFile size in bytes
localPathstringFile path on the local disk
isZipboolIs it a Zip archive
isArchivedboolDetermines whether the file is on a local drive of the agent or moved to the archival location.
typestringTsv, Json
updatedAtDateTimeLast time the file was updated
activityFromDateTimeActivity events in the file are not younger than the date.
activityToDateTimeActivity events in the file are not older than the date.
outputIdstringID of the output that produced the file.
contentUrlstringLink to the file content. MIME type application/x-msdownload

Response Example

[
    {
        "id": "localhost_Log_20190410_000000.tsv",
        "size": 81658576,
        "localPath": "C:\\Program Files\\STEALTHbits\\StealthAUDIT\\FSAC\\SBTFileMon_Logs\\localhost_Log_20190410_000000.tsv",
        "isZip": false,
        "isArchived": false,
        "type": "Tsv",
        "updatedAt": "2019-04-10T17:45:07.2211753Z",
        "activityFrom": "2019-04-05T18:16:57",
        "activityTo": "2019-04-10T17:45:07",
        "outputId": "9c90791891774715bdb3415823790d7c",
        "contentUrl": "https://localhost:4494/api/v1/logs/get/localhost_Log_20190410_000000.tsv"
    },
    {
        "id": "localhost_Log_20190401_000000.tsv.zip",
        "size": 11,
        "localPath": "C:\\Program Files\\STEALTHbits\\StealthAUDIT\\FSAC\\SBTFileMon_Logs\\localhost_Log_20190401_000000.tsv.zip",
        "isZip": true,
        "isArchived": false,
        "type": "Tsv",
        "updatedAt": "2019-04-10T02:03:48.8899252Z",
        "activityFrom": "0001-01-01T00:00:00",
        "activityTo": "2019-04-10T02:03:48.8879242Z",
        "outputId": "9c90791891774715bdb3415823790d7c",
        "contentUrl": "https://localhost:4494/api/v1/logs/get/localhost_Log_20190401_000000.tsv.zip"
    },
  {
    "id": "localhost_Log_20190405.tsv.zip",
    "size": 295102,
    "localPath": "\\\\WRKST0100\\SBACTIVITYLOGS\\WRKST0100\\WRKST0100_9c907918-9177-4715-bdb3-415823790d7c\\localhost_Log_20190405.tsv.zip",
    "isZip": true,
    "isArchived": true,
    "type": "Tsv",
    "updatedAt": "2019-04-05T20:59:55.1462518Z",
    "activityFrom": "2019-04-05T18:16:57",
    "activityTo": "2019-04-05T20:59:55",
    "outputId": "9c90791891774715bdb3415823790d7c",
    "contentUrl": "https://localhost:4494/api/v1/logs/archive/get/WRKST0100/WRKST0100_9c907918-9177-4715-bdb3-415823790d7c/localhost_Log_20190405.tsv.zip"
  }
]

Policy

AttributeTypeDetailed OnlyRead-OnlyDescription
idstringXPolicy ID.
urlstringXSelf URL.
namestringPolicy name.
descriptionstringPolicy description.
pathstringPolicy location.
guidstringXPolicy GUID.
isEnabledboolWhether the policy is enabled.
updatedAtDateTimeXWhen the policy was last modified.
xmlstringPolicy body in XML format. It's the same format used by Threat Prevention Powershell.

Response Example

[
    {
        "id": "1000",
        "url": "https://127.0.0.1:4494/api/v1/domains/KDUD1/policies/1000",
        "name": "SAM AD Changes",
        "description": "",
        "path": "Policies\\Auditing",
        "guid": "56abcb01-0248-4f9c-8e61-aaeb8a30b5ff",
        "isEnabled": true,
        "updatedAt": "2024-08-22T19:05:31.22",
        "xml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<AdConfigPolicy xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" id=\"1000\" enabled=\"true\" enabledHint=\"ManualSwitch\" name=\"SAM AD Changes\" path=\"Policies\\Auditing\" builtIn=\"false\" odbcEnabled=\"true\" syslogEnabled=\"false\" emailAlertingEnabled=\"false\" emailLimiterEnabled=\"true\" emailLimiterMode=\"1\" emailLimiterInterval=\"15\" createdBy=\"SAM\" createdOn=\"2024-08-21T19:14:26.724\" modifiedBy=\"KDDC01$\" modifiedOn=\"2024-08-22T19:05:31.220\" owner=\"KDDC01$\" guid=\"56abcb01-0248-4f9c-8e61-aaeb8a30b5ff\" description=\"\" templateCategory=\"\" policyType=\"kNvMonitor\" ldapPolicyRunDateUtc=\"0001-01-01T00:00:00.000\" ldapPolicyEndDateUtc=\"0001-01-01T00:00:00.000\" ldapPolicyStarted=\"false\" eventSinks=\"{'SAM':{'url':'amqp://localhost:4499','login':'G59/xvKl2Guna0By1UCduG3otKlbUBJD','password':'9TCPAXDkl6IIyx+SvmBNlw=='}}\" eventConsumers=\"\">\r\n  <linkedReports />\r\n  <schedule enabled=\"false\" origin=\"Server\" />\r\n  <registration eventSource=\"AD\" enabled=\"true\" name=\"Active Directory Changes\" description=\"\" erTypeIds=\"1400\">\r\n    <filter type=\"successFailure\" success=\"true\" failure=\"true\" />\r\n    <filter type=\"hostFrom\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n    <filter type=\"windowsPerpetrator\">\r\n      <enableForgedPAC>false</enableForgedPAC>\r\n      <includeList />\r\n      <excludeList />\r\n      <includeRIDs />\r\n    </filter>\r\n    <filter type=\"windowsObject\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n    <filter type=\"windowsAdEvents\">\r\n      <eventTypeFilter>\r\n        <item>Object Added</item>\r\n        <item>Object Modified</item>\r\n        <item>Object Deleted</item>\r\n        <item>Object Moved/Renamed</item>\r\n      </eventTypeFilter>\r\n    </filter>\r\n    <filter type=\"windowsAttr\">\r\n      <includeList />\r\n      <excludeList />\r\n      <includeAttributesList />\r\n      <excludeAttributesList />\r\n    </filter>\r\n    <filter type=\"windowsClass\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n    <filter type=\"windowsContext\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n    <filter type=\"ipAddressFrom\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n    <filter type=\"windowsDomain\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n  </registration>\r\n</AdConfigPolicy>"
    },
    {
        "id": "1001",
        "url": "https://127.0.0.1:4494/api/v1/domains/KDUD1/policies/1001",
        "name": "SAM Authentication",
        "description": "",
        "path": "Policies\\Auditing",
        "guid": "b3d5397b-ef67-4d72-860c-4efa311ad37f",
        "isEnabled": false,
        "updatedAt": "2024-08-22T19:05:31.251",
        "xml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<AdConfigPolicy xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" id=\"1001\" enabled=\"false\" name=\"SAM Authentication\" path=\"Policies\\Auditing\" builtIn=\"false\" odbcEnabled=\"true\" syslogEnabled=\"false\" emailAlertingEnabled=\"false\" emailLimiterEnabled=\"true\" emailLimiterMode=\"1\" emailLimiterInterval=\"15\" createdBy=\"SAM\" createdOn=\"2024-08-21T19:14:26.730\" modifiedBy=\"KDDC01$\" modifiedOn=\"2024-08-22T19:05:31.251\" owner=\"KDDC01$\" guid=\"b3d5397b-ef67-4d72-860c-4efa311ad37f\" description=\"\" templateCategory=\"\" policyType=\"kNvMonitor\" ldapPolicyRunDateUtc=\"0001-01-01T00:00:00.000\" ldapPolicyEndDateUtc=\"0001-01-01T00:00:00.000\" ldapPolicyStarted=\"false\" eventSinks=\"{'SAM':{'url':'amqp://localhost:4499','login':'G59/xvKl2Guna0By1UCduG3otKlbUBJD','password':'9TCPAXDkl6IIyx+SvmBNlw=='}}\" eventConsumers=\"\">\r\n  <linkedReports />\r\n  <schedule enabled=\"false\" origin=\"Server\" />\r\n  <registration eventSource=\"AD\" enabled=\"false\" name=\"Authentication Monitor\" description=\"\" erTypeIds=\"1409\">\r\n    <filter type=\"successFailure\" success=\"true\" failure=\"true\" />\r\n    <filter type=\"authProtocol\" protocol=\"0\" n2password=\"false\" remote_login=\"false\" local_login=\"false\" password_expired=\"false\" />\r\n    <filter type=\"windowsPerpetrator\">\r\n      <enableForgedPAC>false</enableForgedPAC>\r\n      <includeList />\r\n      <excludeList />\r\n      <includeRIDs>\r\n        <item rid=\"512\" />\r\n        <item rid=\"518\" />\r\n        <item rid=\"519\" />\r\n      </includeRIDs>\r\n    </filter>\r\n    <filter type=\"hostTo\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n    <filter type=\"hostFrom\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n    <filter type=\"ipAddressTo\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n    <filter type=\"ipAddressFrom\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n    <filter type=\"windowsDomain\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n  </registration>\r\n</AdConfigPolicy>"
    },
    {
        "id": "1002",
        "url": "https://127.0.0.1:4494/api/v1/domains/KDUD1/policies/1002",
        "name": "SAM Ldap Monitor",
        "description": "",
        "path": "Policies\\Auditing",
        "guid": "b119a08c-5304-45b1-b981-22023a113690",
        "isEnabled": false,
        "updatedAt": "2024-08-22T19:05:31.251",
        "xml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<AdConfigPolicy xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" id=\"1002\" enabled=\"false\" name=\"SAM Ldap Monitor\" path=\"Policies\\Auditing\" builtIn=\"false\" odbcEnabled=\"true\" syslogEnabled=\"false\" emailAlertingEnabled=\"false\" emailLimiterEnabled=\"true\" emailLimiterMode=\"1\" emailLimiterInterval=\"15\" createdBy=\"SAM\" createdOn=\"2024-08-21T19:14:26.732\" modifiedBy=\"KDDC01$\" modifiedOn=\"2024-08-22T19:05:31.251\" owner=\"KDDC01$\" guid=\"b119a08c-5304-45b1-b981-22023a113690\" description=\"\" templateCategory=\"\" policyType=\"kNvMonitor\" ldapPolicyRunDateUtc=\"0001-01-01T00:00:00.000\" ldapPolicyEndDateUtc=\"0001-01-01T00:00:00.000\" ldapPolicyStarted=\"false\" eventSinks=\"{'SAM':{'url':'amqp://localhost:4499','login':'G59/xvKl2Guna0By1UCduG3otKlbUBJD','password':'9TCPAXDkl6IIyx+SvmBNlw=='}}\" eventConsumers=\"\">\r\n  <linkedReports />\r\n  <schedule enabled=\"false\" origin=\"Server\" />\r\n  <registration eventSource=\"LDAP\" enabled=\"false\" name=\"LDAP Monitoring\" description=\"\" erTypeIds=\"1701\">\r\n    <filter type=\"ldapmQuerry\">\r\n      <includeList />\r\n    </filter>\r\n    <filter type=\"successFailure\" success=\"true\" failure=\"true\" />\r\n    <filter type=\"windowsPerpetrator\">\r\n      <enableForgedPAC>false</enableForgedPAC>\r\n      <includeList />\r\n      <excludeList />\r\n      <includeRIDs />\r\n    </filter>\r\n    <filter type=\"ldapmResult\">\r\n      <includeList />\r\n    </filter>\r\n    <filter type=\"hostFrom\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n    <filter type=\"LdapRule\">\r\n      <overrideRule>false</overrideRule>\r\n    </filter>\r\n    <filter type=\"windowsDomain\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n  </registration>\r\n</AdConfigPolicy>"
    },
    {
        "id": "1003",
        "url": "https://127.0.0.1:4494/api/v1/domains/KDUD1/policies/1003",
        "name": "SAM LSASS Guardian",
        "description": "",
        "path": "Policies\\Auditing",
        "guid": "409b77be-f0c2-4ba9-9fb9-d17d2c19084a",
        "isEnabled": false,
        "updatedAt": "2024-08-22T19:05:31.251",
        "xml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<AdConfigPolicy xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" id=\"1003\" enabled=\"false\" name=\"SAM LSASS Guardian\" path=\"Policies\\Auditing\" builtIn=\"false\" odbcEnabled=\"true\" syslogEnabled=\"false\" emailAlertingEnabled=\"false\" emailLimiterEnabled=\"true\" emailLimiterMode=\"1\" emailLimiterInterval=\"15\" createdBy=\"SAM\" createdOn=\"2024-08-21T19:14:26.733\" modifiedBy=\"KDDC01$\" modifiedOn=\"2024-08-22T19:05:31.251\" owner=\"KDDC01$\" guid=\"409b77be-f0c2-4ba9-9fb9-d17d2c19084a\" description=\"\" templateCategory=\"\" policyType=\"kNvMonitor\" ldapPolicyRunDateUtc=\"0001-01-01T00:00:00.000\" ldapPolicyEndDateUtc=\"0001-01-01T00:00:00.000\" ldapPolicyStarted=\"false\" eventSinks=\"{'SAM':{'url':'amqp://localhost:4499','login':'G59/xvKl2Guna0By1UCduG3otKlbUBJD','password':'9TCPAXDkl6IIyx+SvmBNlw=='}}\" eventConsumers=\"\">\r\n  <linkedReports />\r\n  <schedule enabled=\"false\" origin=\"Server\" />\r\n  <registration eventSource=\"AD\" enabled=\"false\" name=\"LSASS Guardian - Monitor\" description=\"\" erTypeIds=\"1802\">\r\n    <filter type=\"windowsPerpetrator\">\r\n      <enableForgedPAC>false</enableForgedPAC>\r\n      <includeList />\r\n      <excludeList />\r\n      <includeRIDs />\r\n    </filter>\r\n    <filter type=\"windowsProcess\">\r\n      <includeList />\r\n      <excludeList>\r\n        <item>MsMpEng.exe</item>\r\n        <item>svchost.exe</item>\r\n        <item>VsTskMgr.exe</item>\r\n        <item>WmiPrvSE.exe</item>\r\n        <item>scan64.exe</item>\r\n        <item>mcshield.exe</item>\r\n      </excludeList>\r\n    </filter>\r\n    <filter type=\"windowsOpenProcessFlags\">3</filter>\r\n    <filter type=\"windowsDomain\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n  </registration>\r\n</AdConfigPolicy>"
    },
    {
        "id": "1004",
        "url": "https://127.0.0.1:4494/api/v1/domains/KDUD1/policies/1004",
        "name": "SAM Replication",
        "description": "",
        "path": "Policies\\Auditing",
        "guid": "e6feb176-8a14-4a61-914b-6c864babd55a",
        "isEnabled": false,
        "updatedAt": "2024-08-22T19:05:31.251",
        "xml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<AdConfigPolicy xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" id=\"1004\" enabled=\"false\" name=\"SAM Replication\" path=\"Policies\\Auditing\" builtIn=\"false\" odbcEnabled=\"true\" syslogEnabled=\"false\" emailAlertingEnabled=\"false\" emailLimiterEnabled=\"true\" emailLimiterMode=\"1\" emailLimiterInterval=\"15\" createdBy=\"SAM\" createdOn=\"2024-08-21T19:14:26.734\" modifiedBy=\"KDDC01$\" modifiedOn=\"2024-08-22T19:05:31.251\" owner=\"KDDC01$\" guid=\"e6feb176-8a14-4a61-914b-6c864babd55a\" description=\"\" templateCategory=\"\" policyType=\"kNvMonitor\" ldapPolicyRunDateUtc=\"0001-01-01T00:00:00.000\" ldapPolicyEndDateUtc=\"0001-01-01T00:00:00.000\" ldapPolicyStarted=\"false\" eventSinks=\"{'SAM':{'url':'amqp://localhost:4499','login':'G59/xvKl2Guna0By1UCduG3otKlbUBJD','password':'9TCPAXDkl6IIyx+SvmBNlw=='}}\" eventConsumers=\"\">\r\n  <linkedReports />\r\n  <schedule enabled=\"false\" origin=\"Server\" />\r\n  <registration eventSource=\"AD\" enabled=\"false\" name=\"AD Replication Monitoring\" description=\"\" erTypeIds=\"1801\">\r\n    <filter type=\"hostFrom\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n    <filter type=\"windowsPerpetrator\">\r\n      <enableForgedPAC>false</enableForgedPAC>\r\n      <includeList />\r\n      <excludeList />\r\n      <includeRIDs />\r\n    </filter>\r\n    <filter type=\"windowsDomain\">\r\n      <includeList />\r\n      <excludeList />\r\n    </filter>\r\n  </registration>\r\n</AdConfigPolicy>"
    }
]