SIEM HTTP Destinations
A SIEM HTTP Destination defines where Files.com sends the log types you select. For HTTP destinations, Files.com sends JSON to the configured endpoint. For file destinations, Files.com writes JSON or CSV files to the configured folder.
List SIEM HTTP Destinations
SDK Method
siemhttpdestination.List()
Return Object
[]*SiemHttpDestination
Authorization Requirement
Requires a Site-Wide API key, or a User API key or session from a Site Administrator.
Additional Arguments
Show SIEM HTTP Destination
SDK Method
siemhttpdestination.Find()
Return Object
SiemHttpDestination
Authorization Requirement
Requires a Site-Wide API key, or a User API key or session from a Site Administrator.
SiemHttpDestinationFindParams Fields
| Field | Description |
|---|---|
| Id int64 Required | Siem Http Destination ID. |
Create SIEM HTTP Destination
SDK Method
siemhttpdestination.Create()
Return Object
SiemHttpDestination
Authorization Requirement
Requires a Site-Wide API key, or a User API key or session from a Site Administrator.
SiemHttpDestinationCreateParams Fields
| Field | Default | Description |
|---|---|---|
| Name string | Name for this Destination | |
| AdditionalHeaders object | Additional HTTP Headers included in calls to the destination URL | |
| SendingActive boolean | true | Whether this SIEM HTTP Destination is currently being sent to or not |
| GenericPayloadType string | Applicable only for destination type: generic. Indicates the type of HTTP body. Can be json_newline or json_array. json_newline is multiple log entries as JSON separated by newlines. json_array is a single JSON array containing multiple log entries as JSON. Possible values: json_newline, json_array | |
| FileDestinationPath string | Applicable only for destination type: file. Destination folder path on Files.com. | |
| FileFormat string | Applicable only for destination type: file. Generated file format. Possible values: json, csv | |
| FileIntervalMinutes int64 | Applicable only for destination type: file. Interval, in minutes, between file deliveries. Valid values are 5, 10, 15, 20, 30, 60, 90, 180, 240, 360. | |
| SplunkToken string | Applicable only for destination types: splunk, splunk_compatible. Authentication token for the destination. | |
| CrowdstrikeToken string | Applicable only for destination type: crowdstrike. Authentication token provided by Crowdstrike. | |
| AzureDcrImmutableId string | Applicable only for destination types: azure, azure_legacy. Immutable ID of the Data Collection Rule. | |
| AzureStreamName string | Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table. | |
| AzureOauthClientCredentialsTenantId string | Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Tenant ID. | |
| AzureOauthClientCredentialsClientId string | Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Client ID. | |
| AzureOauthClientCredentialsClientSecret string | Applicable only for destination type: azure. Client Credentials OAuth Client Secret. | |
| QradarUsername string | Applicable only for destination type: qradar. Basic auth username provided by QRadar. | |
| QradarPassword string | Applicable only for destination type: qradar. Basic auth password provided by QRadar. | |
| SolarWindsToken string | Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds. | |
| NewRelicApiKey string | Applicable only for destination type: new_relic. API key provided by New Relic. | |
| DatadogApiKey string | Applicable only for destination type: datadog. API key provided by Datadog. | |
| ActionSendEnabled boolean | false | Whether or not sending is enabled for action logs. |
| SftpActionSendEnabled boolean | false | Whether or not sending is enabled for sftp_action logs. |
| FtpActionSendEnabled boolean | false | Whether or not sending is enabled for ftp_action logs. |
| WebDavActionSendEnabled boolean | false | Whether or not sending is enabled for web_dav_action logs. |
| SyncSendEnabled boolean | false | Whether or not sending is enabled for sync logs. |
| OutboundConnectionSendEnabled boolean | false | Whether or not sending is enabled for outbound_connection logs. |
| AutomationSendEnabled boolean | false | Whether or not sending is enabled for automation logs. |
| ApiRequestSendEnabled boolean | false | Whether or not sending is enabled for api_request logs. |
| PublicHostingRequestSendEnabled boolean | false | Whether or not sending is enabled for public_hosting_request logs. |
| EmailSendEnabled boolean | false | Whether or not sending is enabled for email logs. |
| ExavaultApiRequestSendEnabled boolean | false | Whether or not sending is enabled for exavault_api_request logs. |
| SettingsChangeSendEnabled boolean | false | Whether or not sending is enabled for settings_change logs. |
| DestinationType string Required | Destination Type Possible values: generic, splunk, azure_legacy, qradar, sumo, rapid7, solar_winds, new_relic, datadog, azure, file, crowdstrike, splunk_compatible | |
| DestinationUrl string | Destination Url |
send_test_entry SIEM HTTP Destination
SDK Method
siemhttpdestination.SendTestEntry()
Return Object
No return value.
Authorization Requirement
Requires a Site-Wide API key, or a User API key or session from a Site Administrator.
SiemHttpDestinationSendTestEntryParams Fields
| Field | Description |
|---|---|
| SiemHttpDestinationId int64 | SIEM HTTP Destination ID |
| DestinationType string | Destination Type Possible values: generic, splunk, azure_legacy, qradar, sumo, rapid7, solar_winds, new_relic, datadog, azure, file, crowdstrike, splunk_compatible |
| DestinationUrl string | Destination Url |
| Name string | Name for this Destination |
| AdditionalHeaders object | Additional HTTP Headers included in calls to the destination URL |
| SendingActive boolean | Whether this SIEM HTTP Destination is currently being sent to or not |
| GenericPayloadType string | Applicable only for destination type: generic. Indicates the type of HTTP body. Can be json_newline or json_array. json_newline is multiple log entries as JSON separated by newlines. json_array is a single JSON array containing multiple log entries as JSON. Possible values: json_newline, json_array |
| FileDestinationPath string | Applicable only for destination type: file. Destination folder path on Files.com. |
| FileFormat string | Applicable only for destination type: file. Generated file format. Possible values: json, csv |
| FileIntervalMinutes int64 | Applicable only for destination type: file. Interval, in minutes, between file deliveries. Valid values are 5, 10, 15, 20, 30, 60, 90, 180, 240, 360. |
| SplunkToken string | Applicable only for destination types: splunk, splunk_compatible. Authentication token for the destination. |
| CrowdstrikeToken string | Applicable only for destination type: crowdstrike. Authentication token provided by Crowdstrike. |
| AzureDcrImmutableId string | Applicable only for destination types: azure, azure_legacy. Immutable ID of the Data Collection Rule. |
| AzureStreamName string | Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table. |
| AzureOauthClientCredentialsTenantId string | Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Tenant ID. |
| AzureOauthClientCredentialsClientId string | Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Client ID. |
| AzureOauthClientCredentialsClientSecret string | Applicable only for destination type: azure. Client Credentials OAuth Client Secret. |
| QradarUsername string | Applicable only for destination type: qradar. Basic auth username provided by QRadar. |
| QradarPassword string | Applicable only for destination type: qradar. Basic auth password provided by QRadar. |
| SolarWindsToken string | Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds. |
| NewRelicApiKey string | Applicable only for destination type: new_relic. API key provided by New Relic. |
| DatadogApiKey string | Applicable only for destination type: datadog. API key provided by Datadog. |
| ActionSendEnabled boolean | Whether or not sending is enabled for action logs. |
| SftpActionSendEnabled boolean | Whether or not sending is enabled for sftp_action logs. |
| FtpActionSendEnabled boolean | Whether or not sending is enabled for ftp_action logs. |
| WebDavActionSendEnabled boolean | Whether or not sending is enabled for web_dav_action logs. |
| SyncSendEnabled boolean | Whether or not sending is enabled for sync logs. |
| OutboundConnectionSendEnabled boolean | Whether or not sending is enabled for outbound_connection logs. |
| AutomationSendEnabled boolean | Whether or not sending is enabled for automation logs. |
| ApiRequestSendEnabled boolean | Whether or not sending is enabled for api_request logs. |
| PublicHostingRequestSendEnabled boolean | Whether or not sending is enabled for public_hosting_request logs. |
| EmailSendEnabled boolean | Whether or not sending is enabled for email logs. |
| ExavaultApiRequestSendEnabled boolean | Whether or not sending is enabled for exavault_api_request logs. |
| SettingsChangeSendEnabled boolean | Whether or not sending is enabled for settings_change logs. |
Update SIEM HTTP Destination
SDK Method
siemhttpdestination.Update()
Return Object
SiemHttpDestination
Authorization Requirement
Requires a Site-Wide API key, or a User API key or session from a Site Administrator.
SiemHttpDestinationUpdateParams Fields
| Field | Description |
|---|---|
| Id int64 Required | Siem Http Destination ID. |
| Name string | Name for this Destination |
| AdditionalHeaders object | Additional HTTP Headers included in calls to the destination URL |
| SendingActive boolean | Whether this SIEM HTTP Destination is currently being sent to or not |
| GenericPayloadType string | Applicable only for destination type: generic. Indicates the type of HTTP body. Can be json_newline or json_array. json_newline is multiple log entries as JSON separated by newlines. json_array is a single JSON array containing multiple log entries as JSON. Possible values: json_newline, json_array |
| FileDestinationPath string | Applicable only for destination type: file. Destination folder path on Files.com. |
| FileFormat string | Applicable only for destination type: file. Generated file format. Possible values: json, csv |
| FileIntervalMinutes int64 | Applicable only for destination type: file. Interval, in minutes, between file deliveries. Valid values are 5, 10, 15, 20, 30, 60, 90, 180, 240, 360. |
| SplunkToken string | Applicable only for destination types: splunk, splunk_compatible. Authentication token for the destination. |
| CrowdstrikeToken string | Applicable only for destination type: crowdstrike. Authentication token provided by Crowdstrike. |
| AzureDcrImmutableId string | Applicable only for destination types: azure, azure_legacy. Immutable ID of the Data Collection Rule. |
| AzureStreamName string | Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table. |
| AzureOauthClientCredentialsTenantId string | Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Tenant ID. |
| AzureOauthClientCredentialsClientId string | Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Client ID. |
| AzureOauthClientCredentialsClientSecret string | Applicable only for destination type: azure. Client Credentials OAuth Client Secret. |
| QradarUsername string | Applicable only for destination type: qradar. Basic auth username provided by QRadar. |
| QradarPassword string | Applicable only for destination type: qradar. Basic auth password provided by QRadar. |
| SolarWindsToken string | Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds. |
| NewRelicApiKey string | Applicable only for destination type: new_relic. API key provided by New Relic. |
| DatadogApiKey string | Applicable only for destination type: datadog. API key provided by Datadog. |
| ActionSendEnabled boolean | Whether or not sending is enabled for action logs. |
| SftpActionSendEnabled boolean | Whether or not sending is enabled for sftp_action logs. |
| FtpActionSendEnabled boolean | Whether or not sending is enabled for ftp_action logs. |
| WebDavActionSendEnabled boolean | Whether or not sending is enabled for web_dav_action logs. |
| SyncSendEnabled boolean | Whether or not sending is enabled for sync logs. |
| OutboundConnectionSendEnabled boolean | Whether or not sending is enabled for outbound_connection logs. |
| AutomationSendEnabled boolean | Whether or not sending is enabled for automation logs. |
| ApiRequestSendEnabled boolean | Whether or not sending is enabled for api_request logs. |
| PublicHostingRequestSendEnabled boolean | Whether or not sending is enabled for public_hosting_request logs. |
| EmailSendEnabled boolean | Whether or not sending is enabled for email logs. |
| ExavaultApiRequestSendEnabled boolean | Whether or not sending is enabled for exavault_api_request logs. |
| SettingsChangeSendEnabled boolean | Whether or not sending is enabled for settings_change logs. |
| DestinationType string | Destination Type Possible values: generic, splunk, azure_legacy, qradar, sumo, rapid7, solar_winds, new_relic, datadog, azure, file, crowdstrike, splunk_compatible |
| DestinationUrl string | Destination Url |
Delete SIEM HTTP Destination
SDK Method
siemhttpdestination.Delete()
Return Object
No return value.
Authorization Requirement
Requires a Site-Wide API key, or a User API key or session from a Site Administrator.
SiemHttpDestinationDeleteParams Fields
| Field | Description |
|---|---|
| Id int64 Required | Siem Http Destination ID. |
The SiemHttpDestination Object
Some of the methods above return a SiemHttpDestination object. The attributes of this object are listed below.
| Attribute | Description |
|---|---|
| Id int64 | SIEM HTTP Destination ID |
| Name string | Name for this Destination |
| DestinationType string | Destination Type Possible values: generic, splunk, azure_legacy, qradar, sumo, rapid7, solar_winds, new_relic, datadog, azure, file, crowdstrike, splunk_compatible |
| DestinationUrl string | Destination Url |
| FileDestinationPath string | Applicable only for destination type: file. Destination folder path on Files.com. |
| FileFormat string | Applicable only for destination type: file. Generated file format. Possible values: json, csv |
| FileIntervalMinutes int64 | Applicable only for destination type: file. Interval, in minutes, between file deliveries. |
| AdditionalHeaders object | Additional HTTP Headers included in calls to the destination URL |
| SendingActive boolean | Whether this SIEM HTTP Destination is currently being sent to or not |
| GenericPayloadType string | Applicable only for destination type: generic. Indicates the type of HTTP body. Can be json_newline or json_array. json_newline is multiple log entries as JSON separated by newlines. json_array is a single JSON array containing multiple log entries as JSON. Possible values: json_newline, json_array |
| SplunkTokenMasked string | Applicable only for destination types: splunk, splunk_compatible. Authentication token for the destination. |
| CrowdstrikeTokenMasked string | Applicable only for destination type: crowdstrike. Authentication token provided by Crowdstrike. |
| AzureDcrImmutableId string | Applicable only for destination types: azure, azure_legacy. Immutable ID of the Data Collection Rule. |
| AzureStreamName string | Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table. |
| AzureOauthClientCredentialsTenantId string | Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Tenant ID. |
| AzureOauthClientCredentialsClientId string | Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Client ID. |
| AzureOauthClientCredentialsClientSecretMasked string | Applicable only for destination types: azure, azure_legacy. Client Credentials OAuth Client Secret. |
| QradarUsername string | Applicable only for destination type: qradar. Basic auth username provided by QRadar. |
| QradarPasswordMasked string | Applicable only for destination type: qradar. Basic auth password provided by QRadar. |
| SolarWindsTokenMasked string | Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds. |
| NewRelicApiKeyMasked string | Applicable only for destination type: new_relic. API key provided by New Relic. |
| DatadogApiKeyMasked string | Applicable only for destination type: datadog. API key provided by Datadog. |
| ActionSendEnabled boolean | Whether or not sending is enabled for action logs. |
| ActionEntriesSent int64 | Number of log entries sent for the lifetime of this destination. |
| SftpActionSendEnabled boolean | Whether or not sending is enabled for sftp_action logs. |
| SftpActionEntriesSent int64 | Number of log entries sent for the lifetime of this destination. |
| FtpActionSendEnabled boolean | Whether or not sending is enabled for ftp_action logs. |
| FtpActionEntriesSent int64 | Number of log entries sent for the lifetime of this destination. |
| WebDavActionSendEnabled boolean | Whether or not sending is enabled for web_dav_action logs. |
| WebDavActionEntriesSent int64 | Number of log entries sent for the lifetime of this destination. |
| SyncSendEnabled boolean | Whether or not sending is enabled for sync logs. |
| SyncEntriesSent int64 | Number of log entries sent for the lifetime of this destination. |
| OutboundConnectionSendEnabled boolean | Whether or not sending is enabled for outbound_connection logs. |
| OutboundConnectionEntriesSent int64 | Number of log entries sent for the lifetime of this destination. |
| AutomationSendEnabled boolean | Whether or not sending is enabled for automation logs. |
| AutomationEntriesSent int64 | Number of log entries sent for the lifetime of this destination. |
| ApiRequestSendEnabled boolean | Whether or not sending is enabled for api_request logs. |
| ApiRequestEntriesSent int64 | Number of log entries sent for the lifetime of this destination. |
| PublicHostingRequestSendEnabled boolean | Whether or not sending is enabled for public_hosting_request logs. |
| PublicHostingRequestEntriesSent int64 | Number of log entries sent for the lifetime of this destination. |
| EmailSendEnabled boolean | Whether or not sending is enabled for email logs. |
| EmailEntriesSent int64 | Number of log entries sent for the lifetime of this destination. |
| ExavaultApiRequestSendEnabled boolean | Whether or not sending is enabled for exavault_api_request logs. |
| ExavaultApiRequestEntriesSent int64 | Number of log entries sent for the lifetime of this destination. |
| SettingsChangeSendEnabled boolean | Whether or not sending is enabled for settings_change logs. |
| SettingsChangeEntriesSent int64 | Number of log entries sent for the lifetime of this destination. |
| LastHttpCallTargetType string | Type of URL that was last called. Can be destination_url or azure_oauth_client_credentials_urlPossible values: destination_url, azure_oauth_client_credentials_url, file_destination |
| LastHttpCallSuccess boolean | Was the last HTTP call made successful? |
| LastHttpCallResponseCode int64 | Last HTTP Call Response Code |
| LastHttpCallResponseBody string | Last HTTP Call Response Body. Large responses are truncated. |
| LastHttpCallErrorMessage string | Last HTTP Call Error Message if applicable |
| LastHttpCallTime string | Time of Last HTTP Call |
| LastHttpCallDurationMs int64 | Duration of the last HTTP Call in milliseconds |
| MostRecentHttpCallSuccessTime string | Time of Most Recent Successful HTTP Call |
| ConnectionTestEntry string | Connection Test Entry |
additional_headers
Additional HTTP Headers included in calls to the destination URL
| Value type | Description |
|---|---|
| object of string values | Additional HTTP Headers included in calls to the destination URL |