files.com 1.1.132 → 1.1.133
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/siem_http_destination.md +416 -0
- data/lib/files.com/models/siem_http_destination.rb +773 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a224336961aed7b8737c80b817572cf7aaf7c4091faafdf0d1eaaedf1f249ba7
|
|
4
|
+
data.tar.gz: 29ed2a93f3ef68c13b9a48ac3ed9bd99542bed6a665b8cc4762bfa72c104438a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 740911aa120daa509c56b2068b7b8cec23fa37331767525e9bc207c712bdf64115987fc2b9b64218bc710db51898948cbcb86e6716b9075c63aeddd13821ef71
|
|
7
|
+
data.tar.gz: ff77c42339e2a555baae6b9ebfaefaa8ab925cb8cc6ab0f23041d25b064f516449a92d9baf7439fb36cae7265b5e30626a723a532d42e9a89129d43c88f47ab9
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.133
|
|
@@ -0,0 +1,416 @@
|
|
|
1
|
+
# SiemHttpDestination
|
|
2
|
+
|
|
3
|
+
## Example SiemHttpDestination Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"name": "example",
|
|
9
|
+
"destination_type": "example",
|
|
10
|
+
"destination_url": "example",
|
|
11
|
+
"additional_headers": {
|
|
12
|
+
"key": "example value"
|
|
13
|
+
},
|
|
14
|
+
"sending_active": true,
|
|
15
|
+
"generic_payload_type": "example",
|
|
16
|
+
"splunk_token_masked": "example",
|
|
17
|
+
"azure_dcr_immutable_id": "example",
|
|
18
|
+
"azure_stream_name": "example",
|
|
19
|
+
"azure_oauth_client_credentials_tenant_id": "example",
|
|
20
|
+
"azure_oauth_client_credentials_client_id": "example",
|
|
21
|
+
"azure_oauth_client_credentials_client_secret_masked": "example",
|
|
22
|
+
"qradar_username": "example",
|
|
23
|
+
"qradar_password_masked": "example",
|
|
24
|
+
"solar_winds_token_masked": "example",
|
|
25
|
+
"new_relic_api_key_masked": "example",
|
|
26
|
+
"datadog_api_key_masked": "example",
|
|
27
|
+
"sftp_action_send_enabled": true,
|
|
28
|
+
"sftp_action_records_sent_entries_sent": 1,
|
|
29
|
+
"ftp_action_send_enabled": true,
|
|
30
|
+
"ftp_action_records_sent_entries_sent": 1,
|
|
31
|
+
"web_dav_action_send_enabled": true,
|
|
32
|
+
"web_dav_action_records_sent_entries_sent": 1,
|
|
33
|
+
"sync_send_enabled": true,
|
|
34
|
+
"sync_records_sent_entries_sent": 1,
|
|
35
|
+
"outbound_connection_send_enabled": true,
|
|
36
|
+
"outbound_connection_records_sent_entries_sent": 1,
|
|
37
|
+
"automation_send_enabled": true,
|
|
38
|
+
"automation_records_sent_entries_sent": 1,
|
|
39
|
+
"api_request_send_enabled": true,
|
|
40
|
+
"api_request_records_sent_entries_sent": 1,
|
|
41
|
+
"public_hosting_request_send_enabled": true,
|
|
42
|
+
"public_hosting_request_records_sent_entries_sent": 1,
|
|
43
|
+
"email_send_enabled": true,
|
|
44
|
+
"email_records_sent_entries_sent": 1,
|
|
45
|
+
"exavault_api_request_send_enabled": true,
|
|
46
|
+
"exavault_api_request_records_sent_entries_sent": 1,
|
|
47
|
+
"last_http_call_target_type": "destination_url",
|
|
48
|
+
"last_http_call_success": true,
|
|
49
|
+
"last_http_call_response_code": 1,
|
|
50
|
+
"last_http_call_response_body": "example",
|
|
51
|
+
"last_http_call_error_message": "example",
|
|
52
|
+
"last_http_call_time": "example",
|
|
53
|
+
"last_http_call_duration_ms": 1,
|
|
54
|
+
"most_recent_http_call_success_time": "example",
|
|
55
|
+
"connection_test_entry": "example"
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
* `id` (int64): SIEM HTTP Destination ID
|
|
60
|
+
* `name` (string): Name for this Destination
|
|
61
|
+
* `destination_type` (string): Destination Type
|
|
62
|
+
* `destination_url` (string): Destination Url
|
|
63
|
+
* `additional_headers` (object): Additional HTTP Headers included in calls to the destination URL
|
|
64
|
+
* `sending_active` (boolean): Whether this SIEM HTTP Destination is currently being sent to or not
|
|
65
|
+
* `generic_payload_type` (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.
|
|
66
|
+
* `splunk_token_masked` (string): Applicable only for destination type: splunk. Authentication token provided by Splunk.
|
|
67
|
+
* `azure_dcr_immutable_id` (string): Applicable only for destination type: azure. Immutable ID of the Data Collection Rule.
|
|
68
|
+
* `azure_stream_name` (string): Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
|
|
69
|
+
* `azure_oauth_client_credentials_tenant_id` (string): Applicable only for destination type: azure. Client Credentials OAuth Tenant ID.
|
|
70
|
+
* `azure_oauth_client_credentials_client_id` (string): Applicable only for destination type: azure. Client Credentials OAuth Client ID.
|
|
71
|
+
* `azure_oauth_client_credentials_client_secret_masked` (string): Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
|
|
72
|
+
* `qradar_username` (string): Applicable only for destination type: qradar. Basic auth username provided by QRadar.
|
|
73
|
+
* `qradar_password_masked` (string): Applicable only for destination type: qradar. Basic auth password provided by QRadar.
|
|
74
|
+
* `solar_winds_token_masked` (string): Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
|
|
75
|
+
* `new_relic_api_key_masked` (string): Applicable only for destination type: new_relic. API key provided by New Relic.
|
|
76
|
+
* `datadog_api_key_masked` (string): Applicable only for destination type: datadog. API key provided by Datadog.
|
|
77
|
+
* `sftp_action_send_enabled` (boolean): Whether or not sending is enabled for sftp_action logs.
|
|
78
|
+
* `sftp_action_records_sent_entries_sent` (int64): Number of log entries sent for the lifetime of this destination.
|
|
79
|
+
* `ftp_action_send_enabled` (boolean): Whether or not sending is enabled for ftp_action logs.
|
|
80
|
+
* `ftp_action_records_sent_entries_sent` (int64): Number of log entries sent for the lifetime of this destination.
|
|
81
|
+
* `web_dav_action_send_enabled` (boolean): Whether or not sending is enabled for web_dav_action logs.
|
|
82
|
+
* `web_dav_action_records_sent_entries_sent` (int64): Number of log entries sent for the lifetime of this destination.
|
|
83
|
+
* `sync_send_enabled` (boolean): Whether or not sending is enabled for sync logs.
|
|
84
|
+
* `sync_records_sent_entries_sent` (int64): Number of log entries sent for the lifetime of this destination.
|
|
85
|
+
* `outbound_connection_send_enabled` (boolean): Whether or not sending is enabled for outbound_connection logs.
|
|
86
|
+
* `outbound_connection_records_sent_entries_sent` (int64): Number of log entries sent for the lifetime of this destination.
|
|
87
|
+
* `automation_send_enabled` (boolean): Whether or not sending is enabled for automation logs.
|
|
88
|
+
* `automation_records_sent_entries_sent` (int64): Number of log entries sent for the lifetime of this destination.
|
|
89
|
+
* `api_request_send_enabled` (boolean): Whether or not sending is enabled for api_request logs.
|
|
90
|
+
* `api_request_records_sent_entries_sent` (int64): Number of log entries sent for the lifetime of this destination.
|
|
91
|
+
* `public_hosting_request_send_enabled` (boolean): Whether or not sending is enabled for public_hosting_request logs.
|
|
92
|
+
* `public_hosting_request_records_sent_entries_sent` (int64): Number of log entries sent for the lifetime of this destination.
|
|
93
|
+
* `email_send_enabled` (boolean): Whether or not sending is enabled for email logs.
|
|
94
|
+
* `email_records_sent_entries_sent` (int64): Number of log entries sent for the lifetime of this destination.
|
|
95
|
+
* `exavault_api_request_send_enabled` (boolean): Whether or not sending is enabled for exavault_api_request logs.
|
|
96
|
+
* `exavault_api_request_records_sent_entries_sent` (int64): Number of log entries sent for the lifetime of this destination.
|
|
97
|
+
* `last_http_call_target_type` (string): Type of URL that was last called. Can be `destination_url` or `azure_oauth_client_credentials_url`
|
|
98
|
+
* `last_http_call_success` (boolean): Was the last HTTP call made successful?
|
|
99
|
+
* `last_http_call_response_code` (int64): Last HTTP Call Response Code
|
|
100
|
+
* `last_http_call_response_body` (string): Last HTTP Call Response Body. Large responses are truncated.
|
|
101
|
+
* `last_http_call_error_message` (string): Last HTTP Call Error Message if applicable
|
|
102
|
+
* `last_http_call_time` (string): Time of Last HTTP Call
|
|
103
|
+
* `last_http_call_duration_ms` (int64): Duration of the last HTTP Call in milliseconds
|
|
104
|
+
* `most_recent_http_call_success_time` (string): Time of Most Recent Successful HTTP Call
|
|
105
|
+
* `connection_test_entry` (string): Connection Test Entry
|
|
106
|
+
* `splunk_token` (string): Applicable only for destination type: splunk. Authentication token provided by Splunk.
|
|
107
|
+
* `azure_oauth_client_credentials_client_secret` (string): Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
|
|
108
|
+
* `qradar_password` (string): Applicable only for destination type: qradar. Basic auth password provided by QRadar.
|
|
109
|
+
* `solar_winds_token` (string): Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
|
|
110
|
+
* `new_relic_api_key` (string): Applicable only for destination type: new_relic. API key provided by New Relic.
|
|
111
|
+
* `datadog_api_key` (string): Applicable only for destination type: datadog. API key provided by Datadog.
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## List Siem Http Destinations
|
|
117
|
+
|
|
118
|
+
```
|
|
119
|
+
Files::SiemHttpDestination.list
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Parameters
|
|
123
|
+
|
|
124
|
+
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
125
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Show Siem Http Destination
|
|
131
|
+
|
|
132
|
+
```
|
|
133
|
+
Files::SiemHttpDestination.find(id)
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Parameters
|
|
137
|
+
|
|
138
|
+
* `id` (int64): Required - Siem Http Destination ID.
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
## Create Siem Http Destination
|
|
144
|
+
|
|
145
|
+
```
|
|
146
|
+
Files::SiemHttpDestination.create(
|
|
147
|
+
name: "example",
|
|
148
|
+
additional_headers: {"key":"example value"},
|
|
149
|
+
sending_active: true,
|
|
150
|
+
generic_payload_type: "example",
|
|
151
|
+
azure_dcr_immutable_id: "example",
|
|
152
|
+
azure_stream_name: "example",
|
|
153
|
+
azure_oauth_client_credentials_tenant_id: "example",
|
|
154
|
+
azure_oauth_client_credentials_client_id: "example",
|
|
155
|
+
qradar_username: "example",
|
|
156
|
+
sftp_action_send_enabled: true,
|
|
157
|
+
ftp_action_send_enabled: true,
|
|
158
|
+
web_dav_action_send_enabled: true,
|
|
159
|
+
sync_send_enabled: true,
|
|
160
|
+
outbound_connection_send_enabled: true,
|
|
161
|
+
automation_send_enabled: true,
|
|
162
|
+
api_request_send_enabled: true,
|
|
163
|
+
public_hosting_request_send_enabled: true,
|
|
164
|
+
email_send_enabled: true,
|
|
165
|
+
exavault_api_request_send_enabled: true,
|
|
166
|
+
destination_type: "example",
|
|
167
|
+
destination_url: "example"
|
|
168
|
+
)
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Parameters
|
|
172
|
+
|
|
173
|
+
* `name` (string): Name for this Destination
|
|
174
|
+
* `additional_headers` (object): Additional HTTP Headers included in calls to the destination URL
|
|
175
|
+
* `sending_active` (boolean): Whether this SIEM HTTP Destination is currently being sent to or not
|
|
176
|
+
* `generic_payload_type` (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.
|
|
177
|
+
* `splunk_token` (string): Applicable only for destination type: splunk. Authentication token provided by Splunk.
|
|
178
|
+
* `azure_dcr_immutable_id` (string): Applicable only for destination type: azure. Immutable ID of the Data Collection Rule.
|
|
179
|
+
* `azure_stream_name` (string): Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
|
|
180
|
+
* `azure_oauth_client_credentials_tenant_id` (string): Applicable only for destination type: azure. Client Credentials OAuth Tenant ID.
|
|
181
|
+
* `azure_oauth_client_credentials_client_id` (string): Applicable only for destination type: azure. Client Credentials OAuth Client ID.
|
|
182
|
+
* `azure_oauth_client_credentials_client_secret` (string): Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
|
|
183
|
+
* `qradar_username` (string): Applicable only for destination type: qradar. Basic auth username provided by QRadar.
|
|
184
|
+
* `qradar_password` (string): Applicable only for destination type: qradar. Basic auth password provided by QRadar.
|
|
185
|
+
* `solar_winds_token` (string): Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
|
|
186
|
+
* `new_relic_api_key` (string): Applicable only for destination type: new_relic. API key provided by New Relic.
|
|
187
|
+
* `datadog_api_key` (string): Applicable only for destination type: datadog. API key provided by Datadog.
|
|
188
|
+
* `sftp_action_send_enabled` (boolean): Whether or not sending is enabled for sftp_action logs.
|
|
189
|
+
* `ftp_action_send_enabled` (boolean): Whether or not sending is enabled for ftp_action logs.
|
|
190
|
+
* `web_dav_action_send_enabled` (boolean): Whether or not sending is enabled for web_dav_action logs.
|
|
191
|
+
* `sync_send_enabled` (boolean): Whether or not sending is enabled for sync logs.
|
|
192
|
+
* `outbound_connection_send_enabled` (boolean): Whether or not sending is enabled for outbound_connection logs.
|
|
193
|
+
* `automation_send_enabled` (boolean): Whether or not sending is enabled for automation logs.
|
|
194
|
+
* `api_request_send_enabled` (boolean): Whether or not sending is enabled for api_request logs.
|
|
195
|
+
* `public_hosting_request_send_enabled` (boolean): Whether or not sending is enabled for public_hosting_request logs.
|
|
196
|
+
* `email_send_enabled` (boolean): Whether or not sending is enabled for email logs.
|
|
197
|
+
* `exavault_api_request_send_enabled` (boolean): Whether or not sending is enabled for exavault_api_request logs.
|
|
198
|
+
* `destination_type` (string): Required - Destination Type
|
|
199
|
+
* `destination_url` (string): Required - Destination Url
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
---
|
|
203
|
+
|
|
204
|
+
## send_test_entry Siem Http Destination
|
|
205
|
+
|
|
206
|
+
```
|
|
207
|
+
Files::SiemHttpDestination.send_test_entry(
|
|
208
|
+
siem_http_destination_id: 1,
|
|
209
|
+
destination_type: "example",
|
|
210
|
+
destination_url: "example",
|
|
211
|
+
name: "example",
|
|
212
|
+
additional_headers: {"key":"example value"},
|
|
213
|
+
sending_active: true,
|
|
214
|
+
generic_payload_type: "example",
|
|
215
|
+
azure_dcr_immutable_id: "example",
|
|
216
|
+
azure_stream_name: "example",
|
|
217
|
+
azure_oauth_client_credentials_tenant_id: "example",
|
|
218
|
+
azure_oauth_client_credentials_client_id: "example",
|
|
219
|
+
qradar_username: "example",
|
|
220
|
+
sftp_action_send_enabled: true,
|
|
221
|
+
ftp_action_send_enabled: true,
|
|
222
|
+
web_dav_action_send_enabled: true,
|
|
223
|
+
sync_send_enabled: true,
|
|
224
|
+
outbound_connection_send_enabled: true,
|
|
225
|
+
automation_send_enabled: true,
|
|
226
|
+
api_request_send_enabled: true,
|
|
227
|
+
public_hosting_request_send_enabled: true,
|
|
228
|
+
email_send_enabled: true,
|
|
229
|
+
exavault_api_request_send_enabled: true
|
|
230
|
+
)
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
### Parameters
|
|
234
|
+
|
|
235
|
+
* `siem_http_destination_id` (int64): SIEM HTTP Destination ID
|
|
236
|
+
* `destination_type` (string): Destination Type
|
|
237
|
+
* `destination_url` (string): Destination Url
|
|
238
|
+
* `name` (string): Name for this Destination
|
|
239
|
+
* `additional_headers` (object): Additional HTTP Headers included in calls to the destination URL
|
|
240
|
+
* `sending_active` (boolean): Whether this SIEM HTTP Destination is currently being sent to or not
|
|
241
|
+
* `generic_payload_type` (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.
|
|
242
|
+
* `splunk_token` (string): Applicable only for destination type: splunk. Authentication token provided by Splunk.
|
|
243
|
+
* `azure_dcr_immutable_id` (string): Applicable only for destination type: azure. Immutable ID of the Data Collection Rule.
|
|
244
|
+
* `azure_stream_name` (string): Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
|
|
245
|
+
* `azure_oauth_client_credentials_tenant_id` (string): Applicable only for destination type: azure. Client Credentials OAuth Tenant ID.
|
|
246
|
+
* `azure_oauth_client_credentials_client_id` (string): Applicable only for destination type: azure. Client Credentials OAuth Client ID.
|
|
247
|
+
* `azure_oauth_client_credentials_client_secret` (string): Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
|
|
248
|
+
* `qradar_username` (string): Applicable only for destination type: qradar. Basic auth username provided by QRadar.
|
|
249
|
+
* `qradar_password` (string): Applicable only for destination type: qradar. Basic auth password provided by QRadar.
|
|
250
|
+
* `solar_winds_token` (string): Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
|
|
251
|
+
* `new_relic_api_key` (string): Applicable only for destination type: new_relic. API key provided by New Relic.
|
|
252
|
+
* `datadog_api_key` (string): Applicable only for destination type: datadog. API key provided by Datadog.
|
|
253
|
+
* `sftp_action_send_enabled` (boolean): Whether or not sending is enabled for sftp_action logs.
|
|
254
|
+
* `ftp_action_send_enabled` (boolean): Whether or not sending is enabled for ftp_action logs.
|
|
255
|
+
* `web_dav_action_send_enabled` (boolean): Whether or not sending is enabled for web_dav_action logs.
|
|
256
|
+
* `sync_send_enabled` (boolean): Whether or not sending is enabled for sync logs.
|
|
257
|
+
* `outbound_connection_send_enabled` (boolean): Whether or not sending is enabled for outbound_connection logs.
|
|
258
|
+
* `automation_send_enabled` (boolean): Whether or not sending is enabled for automation logs.
|
|
259
|
+
* `api_request_send_enabled` (boolean): Whether or not sending is enabled for api_request logs.
|
|
260
|
+
* `public_hosting_request_send_enabled` (boolean): Whether or not sending is enabled for public_hosting_request logs.
|
|
261
|
+
* `email_send_enabled` (boolean): Whether or not sending is enabled for email logs.
|
|
262
|
+
* `exavault_api_request_send_enabled` (boolean): Whether or not sending is enabled for exavault_api_request logs.
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
---
|
|
266
|
+
|
|
267
|
+
## Update Siem Http Destination
|
|
268
|
+
|
|
269
|
+
```
|
|
270
|
+
Files::SiemHttpDestination.update(id,
|
|
271
|
+
name: "example",
|
|
272
|
+
additional_headers: {"key":"example value"},
|
|
273
|
+
sending_active: true,
|
|
274
|
+
generic_payload_type: "example",
|
|
275
|
+
azure_dcr_immutable_id: "example",
|
|
276
|
+
azure_stream_name: "example",
|
|
277
|
+
azure_oauth_client_credentials_tenant_id: "example",
|
|
278
|
+
azure_oauth_client_credentials_client_id: "example",
|
|
279
|
+
qradar_username: "example",
|
|
280
|
+
sftp_action_send_enabled: true,
|
|
281
|
+
ftp_action_send_enabled: true,
|
|
282
|
+
web_dav_action_send_enabled: true,
|
|
283
|
+
sync_send_enabled: true,
|
|
284
|
+
outbound_connection_send_enabled: true,
|
|
285
|
+
automation_send_enabled: true,
|
|
286
|
+
api_request_send_enabled: true,
|
|
287
|
+
public_hosting_request_send_enabled: true,
|
|
288
|
+
email_send_enabled: true,
|
|
289
|
+
exavault_api_request_send_enabled: true,
|
|
290
|
+
destination_type: "example",
|
|
291
|
+
destination_url: "example"
|
|
292
|
+
)
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
### Parameters
|
|
296
|
+
|
|
297
|
+
* `id` (int64): Required - Siem Http Destination ID.
|
|
298
|
+
* `name` (string): Name for this Destination
|
|
299
|
+
* `additional_headers` (object): Additional HTTP Headers included in calls to the destination URL
|
|
300
|
+
* `sending_active` (boolean): Whether this SIEM HTTP Destination is currently being sent to or not
|
|
301
|
+
* `generic_payload_type` (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.
|
|
302
|
+
* `splunk_token` (string): Applicable only for destination type: splunk. Authentication token provided by Splunk.
|
|
303
|
+
* `azure_dcr_immutable_id` (string): Applicable only for destination type: azure. Immutable ID of the Data Collection Rule.
|
|
304
|
+
* `azure_stream_name` (string): Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
|
|
305
|
+
* `azure_oauth_client_credentials_tenant_id` (string): Applicable only for destination type: azure. Client Credentials OAuth Tenant ID.
|
|
306
|
+
* `azure_oauth_client_credentials_client_id` (string): Applicable only for destination type: azure. Client Credentials OAuth Client ID.
|
|
307
|
+
* `azure_oauth_client_credentials_client_secret` (string): Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
|
|
308
|
+
* `qradar_username` (string): Applicable only for destination type: qradar. Basic auth username provided by QRadar.
|
|
309
|
+
* `qradar_password` (string): Applicable only for destination type: qradar. Basic auth password provided by QRadar.
|
|
310
|
+
* `solar_winds_token` (string): Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
|
|
311
|
+
* `new_relic_api_key` (string): Applicable only for destination type: new_relic. API key provided by New Relic.
|
|
312
|
+
* `datadog_api_key` (string): Applicable only for destination type: datadog. API key provided by Datadog.
|
|
313
|
+
* `sftp_action_send_enabled` (boolean): Whether or not sending is enabled for sftp_action logs.
|
|
314
|
+
* `ftp_action_send_enabled` (boolean): Whether or not sending is enabled for ftp_action logs.
|
|
315
|
+
* `web_dav_action_send_enabled` (boolean): Whether or not sending is enabled for web_dav_action logs.
|
|
316
|
+
* `sync_send_enabled` (boolean): Whether or not sending is enabled for sync logs.
|
|
317
|
+
* `outbound_connection_send_enabled` (boolean): Whether or not sending is enabled for outbound_connection logs.
|
|
318
|
+
* `automation_send_enabled` (boolean): Whether or not sending is enabled for automation logs.
|
|
319
|
+
* `api_request_send_enabled` (boolean): Whether or not sending is enabled for api_request logs.
|
|
320
|
+
* `public_hosting_request_send_enabled` (boolean): Whether or not sending is enabled for public_hosting_request logs.
|
|
321
|
+
* `email_send_enabled` (boolean): Whether or not sending is enabled for email logs.
|
|
322
|
+
* `exavault_api_request_send_enabled` (boolean): Whether or not sending is enabled for exavault_api_request logs.
|
|
323
|
+
* `destination_type` (string): Destination Type
|
|
324
|
+
* `destination_url` (string): Destination Url
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
---
|
|
328
|
+
|
|
329
|
+
## Delete Siem Http Destination
|
|
330
|
+
|
|
331
|
+
```
|
|
332
|
+
Files::SiemHttpDestination.delete(id)
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
### Parameters
|
|
336
|
+
|
|
337
|
+
* `id` (int64): Required - Siem Http Destination ID.
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
---
|
|
341
|
+
|
|
342
|
+
## Update Siem Http Destination
|
|
343
|
+
|
|
344
|
+
```
|
|
345
|
+
siem_http_destination = Files::SiemHttpDestination.find(id)
|
|
346
|
+
|
|
347
|
+
siem_http_destination.update(
|
|
348
|
+
name: "example",
|
|
349
|
+
additional_headers: {"key":"example value"},
|
|
350
|
+
sending_active: true,
|
|
351
|
+
generic_payload_type: "example",
|
|
352
|
+
azure_dcr_immutable_id: "example",
|
|
353
|
+
azure_stream_name: "example",
|
|
354
|
+
azure_oauth_client_credentials_tenant_id: "example",
|
|
355
|
+
azure_oauth_client_credentials_client_id: "example",
|
|
356
|
+
qradar_username: "example",
|
|
357
|
+
sftp_action_send_enabled: true,
|
|
358
|
+
ftp_action_send_enabled: true,
|
|
359
|
+
web_dav_action_send_enabled: true,
|
|
360
|
+
sync_send_enabled: true,
|
|
361
|
+
outbound_connection_send_enabled: true,
|
|
362
|
+
automation_send_enabled: true,
|
|
363
|
+
api_request_send_enabled: true,
|
|
364
|
+
public_hosting_request_send_enabled: true,
|
|
365
|
+
email_send_enabled: true,
|
|
366
|
+
exavault_api_request_send_enabled: true,
|
|
367
|
+
destination_type: "example",
|
|
368
|
+
destination_url: "example"
|
|
369
|
+
)
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### Parameters
|
|
373
|
+
|
|
374
|
+
* `id` (int64): Required - Siem Http Destination ID.
|
|
375
|
+
* `name` (string): Name for this Destination
|
|
376
|
+
* `additional_headers` (object): Additional HTTP Headers included in calls to the destination URL
|
|
377
|
+
* `sending_active` (boolean): Whether this SIEM HTTP Destination is currently being sent to or not
|
|
378
|
+
* `generic_payload_type` (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.
|
|
379
|
+
* `splunk_token` (string): Applicable only for destination type: splunk. Authentication token provided by Splunk.
|
|
380
|
+
* `azure_dcr_immutable_id` (string): Applicable only for destination type: azure. Immutable ID of the Data Collection Rule.
|
|
381
|
+
* `azure_stream_name` (string): Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
|
|
382
|
+
* `azure_oauth_client_credentials_tenant_id` (string): Applicable only for destination type: azure. Client Credentials OAuth Tenant ID.
|
|
383
|
+
* `azure_oauth_client_credentials_client_id` (string): Applicable only for destination type: azure. Client Credentials OAuth Client ID.
|
|
384
|
+
* `azure_oauth_client_credentials_client_secret` (string): Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
|
|
385
|
+
* `qradar_username` (string): Applicable only for destination type: qradar. Basic auth username provided by QRadar.
|
|
386
|
+
* `qradar_password` (string): Applicable only for destination type: qradar. Basic auth password provided by QRadar.
|
|
387
|
+
* `solar_winds_token` (string): Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
|
|
388
|
+
* `new_relic_api_key` (string): Applicable only for destination type: new_relic. API key provided by New Relic.
|
|
389
|
+
* `datadog_api_key` (string): Applicable only for destination type: datadog. API key provided by Datadog.
|
|
390
|
+
* `sftp_action_send_enabled` (boolean): Whether or not sending is enabled for sftp_action logs.
|
|
391
|
+
* `ftp_action_send_enabled` (boolean): Whether or not sending is enabled for ftp_action logs.
|
|
392
|
+
* `web_dav_action_send_enabled` (boolean): Whether or not sending is enabled for web_dav_action logs.
|
|
393
|
+
* `sync_send_enabled` (boolean): Whether or not sending is enabled for sync logs.
|
|
394
|
+
* `outbound_connection_send_enabled` (boolean): Whether or not sending is enabled for outbound_connection logs.
|
|
395
|
+
* `automation_send_enabled` (boolean): Whether or not sending is enabled for automation logs.
|
|
396
|
+
* `api_request_send_enabled` (boolean): Whether or not sending is enabled for api_request logs.
|
|
397
|
+
* `public_hosting_request_send_enabled` (boolean): Whether or not sending is enabled for public_hosting_request logs.
|
|
398
|
+
* `email_send_enabled` (boolean): Whether or not sending is enabled for email logs.
|
|
399
|
+
* `exavault_api_request_send_enabled` (boolean): Whether or not sending is enabled for exavault_api_request logs.
|
|
400
|
+
* `destination_type` (string): Destination Type
|
|
401
|
+
* `destination_url` (string): Destination Url
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
---
|
|
405
|
+
|
|
406
|
+
## Delete Siem Http Destination
|
|
407
|
+
|
|
408
|
+
```
|
|
409
|
+
siem_http_destination = Files::SiemHttpDestination.find(id)
|
|
410
|
+
|
|
411
|
+
siem_http_destination.delete
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
### Parameters
|
|
415
|
+
|
|
416
|
+
* `id` (int64): Required - Siem Http Destination ID.
|
|
@@ -0,0 +1,773 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class SiemHttpDestination
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# int64 - SIEM HTTP Destination ID
|
|
13
|
+
def id
|
|
14
|
+
@attributes[:id]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
def id=(value)
|
|
18
|
+
@attributes[:id] = value
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# string - Name for this Destination
|
|
22
|
+
def name
|
|
23
|
+
@attributes[:name]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def name=(value)
|
|
27
|
+
@attributes[:name] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
# string - Destination Type
|
|
31
|
+
def destination_type
|
|
32
|
+
@attributes[:destination_type]
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
def destination_type=(value)
|
|
36
|
+
@attributes[:destination_type] = value
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# string - Destination Url
|
|
40
|
+
def destination_url
|
|
41
|
+
@attributes[:destination_url]
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
def destination_url=(value)
|
|
45
|
+
@attributes[:destination_url] = value
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# object - Additional HTTP Headers included in calls to the destination URL
|
|
49
|
+
def additional_headers
|
|
50
|
+
@attributes[:additional_headers]
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def additional_headers=(value)
|
|
54
|
+
@attributes[:additional_headers] = value
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# boolean - Whether this SIEM HTTP Destination is currently being sent to or not
|
|
58
|
+
def sending_active
|
|
59
|
+
@attributes[:sending_active]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def sending_active=(value)
|
|
63
|
+
@attributes[:sending_active] = value
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# 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.
|
|
67
|
+
def generic_payload_type
|
|
68
|
+
@attributes[:generic_payload_type]
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def generic_payload_type=(value)
|
|
72
|
+
@attributes[:generic_payload_type] = value
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# string - Applicable only for destination type: splunk. Authentication token provided by Splunk.
|
|
76
|
+
def splunk_token_masked
|
|
77
|
+
@attributes[:splunk_token_masked]
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
def splunk_token_masked=(value)
|
|
81
|
+
@attributes[:splunk_token_masked] = value
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# string - Applicable only for destination type: azure. Immutable ID of the Data Collection Rule.
|
|
85
|
+
def azure_dcr_immutable_id
|
|
86
|
+
@attributes[:azure_dcr_immutable_id]
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
def azure_dcr_immutable_id=(value)
|
|
90
|
+
@attributes[:azure_dcr_immutable_id] = value
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# string - Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
|
|
94
|
+
def azure_stream_name
|
|
95
|
+
@attributes[:azure_stream_name]
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
def azure_stream_name=(value)
|
|
99
|
+
@attributes[:azure_stream_name] = value
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# string - Applicable only for destination type: azure. Client Credentials OAuth Tenant ID.
|
|
103
|
+
def azure_oauth_client_credentials_tenant_id
|
|
104
|
+
@attributes[:azure_oauth_client_credentials_tenant_id]
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
def azure_oauth_client_credentials_tenant_id=(value)
|
|
108
|
+
@attributes[:azure_oauth_client_credentials_tenant_id] = value
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# string - Applicable only for destination type: azure. Client Credentials OAuth Client ID.
|
|
112
|
+
def azure_oauth_client_credentials_client_id
|
|
113
|
+
@attributes[:azure_oauth_client_credentials_client_id]
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
def azure_oauth_client_credentials_client_id=(value)
|
|
117
|
+
@attributes[:azure_oauth_client_credentials_client_id] = value
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# string - Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
|
|
121
|
+
def azure_oauth_client_credentials_client_secret_masked
|
|
122
|
+
@attributes[:azure_oauth_client_credentials_client_secret_masked]
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
def azure_oauth_client_credentials_client_secret_masked=(value)
|
|
126
|
+
@attributes[:azure_oauth_client_credentials_client_secret_masked] = value
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
# string - Applicable only for destination type: qradar. Basic auth username provided by QRadar.
|
|
130
|
+
def qradar_username
|
|
131
|
+
@attributes[:qradar_username]
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
def qradar_username=(value)
|
|
135
|
+
@attributes[:qradar_username] = value
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# string - Applicable only for destination type: qradar. Basic auth password provided by QRadar.
|
|
139
|
+
def qradar_password_masked
|
|
140
|
+
@attributes[:qradar_password_masked]
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
def qradar_password_masked=(value)
|
|
144
|
+
@attributes[:qradar_password_masked] = value
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# string - Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
|
|
148
|
+
def solar_winds_token_masked
|
|
149
|
+
@attributes[:solar_winds_token_masked]
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
def solar_winds_token_masked=(value)
|
|
153
|
+
@attributes[:solar_winds_token_masked] = value
|
|
154
|
+
end
|
|
155
|
+
|
|
156
|
+
# string - Applicable only for destination type: new_relic. API key provided by New Relic.
|
|
157
|
+
def new_relic_api_key_masked
|
|
158
|
+
@attributes[:new_relic_api_key_masked]
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
def new_relic_api_key_masked=(value)
|
|
162
|
+
@attributes[:new_relic_api_key_masked] = value
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# string - Applicable only for destination type: datadog. API key provided by Datadog.
|
|
166
|
+
def datadog_api_key_masked
|
|
167
|
+
@attributes[:datadog_api_key_masked]
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
def datadog_api_key_masked=(value)
|
|
171
|
+
@attributes[:datadog_api_key_masked] = value
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# boolean - Whether or not sending is enabled for sftp_action logs.
|
|
175
|
+
def sftp_action_send_enabled
|
|
176
|
+
@attributes[:sftp_action_send_enabled]
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
def sftp_action_send_enabled=(value)
|
|
180
|
+
@attributes[:sftp_action_send_enabled] = value
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
# int64 - Number of log entries sent for the lifetime of this destination.
|
|
184
|
+
def sftp_action_records_sent_entries_sent
|
|
185
|
+
@attributes[:sftp_action_records_sent_entries_sent]
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
def sftp_action_records_sent_entries_sent=(value)
|
|
189
|
+
@attributes[:sftp_action_records_sent_entries_sent] = value
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
# boolean - Whether or not sending is enabled for ftp_action logs.
|
|
193
|
+
def ftp_action_send_enabled
|
|
194
|
+
@attributes[:ftp_action_send_enabled]
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
def ftp_action_send_enabled=(value)
|
|
198
|
+
@attributes[:ftp_action_send_enabled] = value
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# int64 - Number of log entries sent for the lifetime of this destination.
|
|
202
|
+
def ftp_action_records_sent_entries_sent
|
|
203
|
+
@attributes[:ftp_action_records_sent_entries_sent]
|
|
204
|
+
end
|
|
205
|
+
|
|
206
|
+
def ftp_action_records_sent_entries_sent=(value)
|
|
207
|
+
@attributes[:ftp_action_records_sent_entries_sent] = value
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# boolean - Whether or not sending is enabled for web_dav_action logs.
|
|
211
|
+
def web_dav_action_send_enabled
|
|
212
|
+
@attributes[:web_dav_action_send_enabled]
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
def web_dav_action_send_enabled=(value)
|
|
216
|
+
@attributes[:web_dav_action_send_enabled] = value
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
# int64 - Number of log entries sent for the lifetime of this destination.
|
|
220
|
+
def web_dav_action_records_sent_entries_sent
|
|
221
|
+
@attributes[:web_dav_action_records_sent_entries_sent]
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
def web_dav_action_records_sent_entries_sent=(value)
|
|
225
|
+
@attributes[:web_dav_action_records_sent_entries_sent] = value
|
|
226
|
+
end
|
|
227
|
+
|
|
228
|
+
# boolean - Whether or not sending is enabled for sync logs.
|
|
229
|
+
def sync_send_enabled
|
|
230
|
+
@attributes[:sync_send_enabled]
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
def sync_send_enabled=(value)
|
|
234
|
+
@attributes[:sync_send_enabled] = value
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
# int64 - Number of log entries sent for the lifetime of this destination.
|
|
238
|
+
def sync_records_sent_entries_sent
|
|
239
|
+
@attributes[:sync_records_sent_entries_sent]
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
def sync_records_sent_entries_sent=(value)
|
|
243
|
+
@attributes[:sync_records_sent_entries_sent] = value
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
# boolean - Whether or not sending is enabled for outbound_connection logs.
|
|
247
|
+
def outbound_connection_send_enabled
|
|
248
|
+
@attributes[:outbound_connection_send_enabled]
|
|
249
|
+
end
|
|
250
|
+
|
|
251
|
+
def outbound_connection_send_enabled=(value)
|
|
252
|
+
@attributes[:outbound_connection_send_enabled] = value
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# int64 - Number of log entries sent for the lifetime of this destination.
|
|
256
|
+
def outbound_connection_records_sent_entries_sent
|
|
257
|
+
@attributes[:outbound_connection_records_sent_entries_sent]
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
def outbound_connection_records_sent_entries_sent=(value)
|
|
261
|
+
@attributes[:outbound_connection_records_sent_entries_sent] = value
|
|
262
|
+
end
|
|
263
|
+
|
|
264
|
+
# boolean - Whether or not sending is enabled for automation logs.
|
|
265
|
+
def automation_send_enabled
|
|
266
|
+
@attributes[:automation_send_enabled]
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
def automation_send_enabled=(value)
|
|
270
|
+
@attributes[:automation_send_enabled] = value
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
# int64 - Number of log entries sent for the lifetime of this destination.
|
|
274
|
+
def automation_records_sent_entries_sent
|
|
275
|
+
@attributes[:automation_records_sent_entries_sent]
|
|
276
|
+
end
|
|
277
|
+
|
|
278
|
+
def automation_records_sent_entries_sent=(value)
|
|
279
|
+
@attributes[:automation_records_sent_entries_sent] = value
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
# boolean - Whether or not sending is enabled for api_request logs.
|
|
283
|
+
def api_request_send_enabled
|
|
284
|
+
@attributes[:api_request_send_enabled]
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
def api_request_send_enabled=(value)
|
|
288
|
+
@attributes[:api_request_send_enabled] = value
|
|
289
|
+
end
|
|
290
|
+
|
|
291
|
+
# int64 - Number of log entries sent for the lifetime of this destination.
|
|
292
|
+
def api_request_records_sent_entries_sent
|
|
293
|
+
@attributes[:api_request_records_sent_entries_sent]
|
|
294
|
+
end
|
|
295
|
+
|
|
296
|
+
def api_request_records_sent_entries_sent=(value)
|
|
297
|
+
@attributes[:api_request_records_sent_entries_sent] = value
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
# boolean - Whether or not sending is enabled for public_hosting_request logs.
|
|
301
|
+
def public_hosting_request_send_enabled
|
|
302
|
+
@attributes[:public_hosting_request_send_enabled]
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
def public_hosting_request_send_enabled=(value)
|
|
306
|
+
@attributes[:public_hosting_request_send_enabled] = value
|
|
307
|
+
end
|
|
308
|
+
|
|
309
|
+
# int64 - Number of log entries sent for the lifetime of this destination.
|
|
310
|
+
def public_hosting_request_records_sent_entries_sent
|
|
311
|
+
@attributes[:public_hosting_request_records_sent_entries_sent]
|
|
312
|
+
end
|
|
313
|
+
|
|
314
|
+
def public_hosting_request_records_sent_entries_sent=(value)
|
|
315
|
+
@attributes[:public_hosting_request_records_sent_entries_sent] = value
|
|
316
|
+
end
|
|
317
|
+
|
|
318
|
+
# boolean - Whether or not sending is enabled for email logs.
|
|
319
|
+
def email_send_enabled
|
|
320
|
+
@attributes[:email_send_enabled]
|
|
321
|
+
end
|
|
322
|
+
|
|
323
|
+
def email_send_enabled=(value)
|
|
324
|
+
@attributes[:email_send_enabled] = value
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
# int64 - Number of log entries sent for the lifetime of this destination.
|
|
328
|
+
def email_records_sent_entries_sent
|
|
329
|
+
@attributes[:email_records_sent_entries_sent]
|
|
330
|
+
end
|
|
331
|
+
|
|
332
|
+
def email_records_sent_entries_sent=(value)
|
|
333
|
+
@attributes[:email_records_sent_entries_sent] = value
|
|
334
|
+
end
|
|
335
|
+
|
|
336
|
+
# boolean - Whether or not sending is enabled for exavault_api_request logs.
|
|
337
|
+
def exavault_api_request_send_enabled
|
|
338
|
+
@attributes[:exavault_api_request_send_enabled]
|
|
339
|
+
end
|
|
340
|
+
|
|
341
|
+
def exavault_api_request_send_enabled=(value)
|
|
342
|
+
@attributes[:exavault_api_request_send_enabled] = value
|
|
343
|
+
end
|
|
344
|
+
|
|
345
|
+
# int64 - Number of log entries sent for the lifetime of this destination.
|
|
346
|
+
def exavault_api_request_records_sent_entries_sent
|
|
347
|
+
@attributes[:exavault_api_request_records_sent_entries_sent]
|
|
348
|
+
end
|
|
349
|
+
|
|
350
|
+
def exavault_api_request_records_sent_entries_sent=(value)
|
|
351
|
+
@attributes[:exavault_api_request_records_sent_entries_sent] = value
|
|
352
|
+
end
|
|
353
|
+
|
|
354
|
+
# string - Type of URL that was last called. Can be `destination_url` or `azure_oauth_client_credentials_url`
|
|
355
|
+
def last_http_call_target_type
|
|
356
|
+
@attributes[:last_http_call_target_type]
|
|
357
|
+
end
|
|
358
|
+
|
|
359
|
+
def last_http_call_target_type=(value)
|
|
360
|
+
@attributes[:last_http_call_target_type] = value
|
|
361
|
+
end
|
|
362
|
+
|
|
363
|
+
# boolean - Was the last HTTP call made successful?
|
|
364
|
+
def last_http_call_success
|
|
365
|
+
@attributes[:last_http_call_success]
|
|
366
|
+
end
|
|
367
|
+
|
|
368
|
+
def last_http_call_success=(value)
|
|
369
|
+
@attributes[:last_http_call_success] = value
|
|
370
|
+
end
|
|
371
|
+
|
|
372
|
+
# int64 - Last HTTP Call Response Code
|
|
373
|
+
def last_http_call_response_code
|
|
374
|
+
@attributes[:last_http_call_response_code]
|
|
375
|
+
end
|
|
376
|
+
|
|
377
|
+
def last_http_call_response_code=(value)
|
|
378
|
+
@attributes[:last_http_call_response_code] = value
|
|
379
|
+
end
|
|
380
|
+
|
|
381
|
+
# string - Last HTTP Call Response Body. Large responses are truncated.
|
|
382
|
+
def last_http_call_response_body
|
|
383
|
+
@attributes[:last_http_call_response_body]
|
|
384
|
+
end
|
|
385
|
+
|
|
386
|
+
def last_http_call_response_body=(value)
|
|
387
|
+
@attributes[:last_http_call_response_body] = value
|
|
388
|
+
end
|
|
389
|
+
|
|
390
|
+
# string - Last HTTP Call Error Message if applicable
|
|
391
|
+
def last_http_call_error_message
|
|
392
|
+
@attributes[:last_http_call_error_message]
|
|
393
|
+
end
|
|
394
|
+
|
|
395
|
+
def last_http_call_error_message=(value)
|
|
396
|
+
@attributes[:last_http_call_error_message] = value
|
|
397
|
+
end
|
|
398
|
+
|
|
399
|
+
# string - Time of Last HTTP Call
|
|
400
|
+
def last_http_call_time
|
|
401
|
+
@attributes[:last_http_call_time]
|
|
402
|
+
end
|
|
403
|
+
|
|
404
|
+
def last_http_call_time=(value)
|
|
405
|
+
@attributes[:last_http_call_time] = value
|
|
406
|
+
end
|
|
407
|
+
|
|
408
|
+
# int64 - Duration of the last HTTP Call in milliseconds
|
|
409
|
+
def last_http_call_duration_ms
|
|
410
|
+
@attributes[:last_http_call_duration_ms]
|
|
411
|
+
end
|
|
412
|
+
|
|
413
|
+
def last_http_call_duration_ms=(value)
|
|
414
|
+
@attributes[:last_http_call_duration_ms] = value
|
|
415
|
+
end
|
|
416
|
+
|
|
417
|
+
# string - Time of Most Recent Successful HTTP Call
|
|
418
|
+
def most_recent_http_call_success_time
|
|
419
|
+
@attributes[:most_recent_http_call_success_time]
|
|
420
|
+
end
|
|
421
|
+
|
|
422
|
+
def most_recent_http_call_success_time=(value)
|
|
423
|
+
@attributes[:most_recent_http_call_success_time] = value
|
|
424
|
+
end
|
|
425
|
+
|
|
426
|
+
# string - Connection Test Entry
|
|
427
|
+
def connection_test_entry
|
|
428
|
+
@attributes[:connection_test_entry]
|
|
429
|
+
end
|
|
430
|
+
|
|
431
|
+
def connection_test_entry=(value)
|
|
432
|
+
@attributes[:connection_test_entry] = value
|
|
433
|
+
end
|
|
434
|
+
|
|
435
|
+
# string - Applicable only for destination type: splunk. Authentication token provided by Splunk.
|
|
436
|
+
def splunk_token
|
|
437
|
+
@attributes[:splunk_token]
|
|
438
|
+
end
|
|
439
|
+
|
|
440
|
+
def splunk_token=(value)
|
|
441
|
+
@attributes[:splunk_token] = value
|
|
442
|
+
end
|
|
443
|
+
|
|
444
|
+
# string - Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
|
|
445
|
+
def azure_oauth_client_credentials_client_secret
|
|
446
|
+
@attributes[:azure_oauth_client_credentials_client_secret]
|
|
447
|
+
end
|
|
448
|
+
|
|
449
|
+
def azure_oauth_client_credentials_client_secret=(value)
|
|
450
|
+
@attributes[:azure_oauth_client_credentials_client_secret] = value
|
|
451
|
+
end
|
|
452
|
+
|
|
453
|
+
# string - Applicable only for destination type: qradar. Basic auth password provided by QRadar.
|
|
454
|
+
def qradar_password
|
|
455
|
+
@attributes[:qradar_password]
|
|
456
|
+
end
|
|
457
|
+
|
|
458
|
+
def qradar_password=(value)
|
|
459
|
+
@attributes[:qradar_password] = value
|
|
460
|
+
end
|
|
461
|
+
|
|
462
|
+
# string - Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
|
|
463
|
+
def solar_winds_token
|
|
464
|
+
@attributes[:solar_winds_token]
|
|
465
|
+
end
|
|
466
|
+
|
|
467
|
+
def solar_winds_token=(value)
|
|
468
|
+
@attributes[:solar_winds_token] = value
|
|
469
|
+
end
|
|
470
|
+
|
|
471
|
+
# string - Applicable only for destination type: new_relic. API key provided by New Relic.
|
|
472
|
+
def new_relic_api_key
|
|
473
|
+
@attributes[:new_relic_api_key]
|
|
474
|
+
end
|
|
475
|
+
|
|
476
|
+
def new_relic_api_key=(value)
|
|
477
|
+
@attributes[:new_relic_api_key] = value
|
|
478
|
+
end
|
|
479
|
+
|
|
480
|
+
# string - Applicable only for destination type: datadog. API key provided by Datadog.
|
|
481
|
+
def datadog_api_key
|
|
482
|
+
@attributes[:datadog_api_key]
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
def datadog_api_key=(value)
|
|
486
|
+
@attributes[:datadog_api_key] = value
|
|
487
|
+
end
|
|
488
|
+
|
|
489
|
+
# Parameters:
|
|
490
|
+
# name - string - Name for this Destination
|
|
491
|
+
# additional_headers - object - Additional HTTP Headers included in calls to the destination URL
|
|
492
|
+
# sending_active - boolean - Whether this SIEM HTTP Destination is currently being sent to or not
|
|
493
|
+
# generic_payload_type - 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.
|
|
494
|
+
# splunk_token - string - Applicable only for destination type: splunk. Authentication token provided by Splunk.
|
|
495
|
+
# azure_dcr_immutable_id - string - Applicable only for destination type: azure. Immutable ID of the Data Collection Rule.
|
|
496
|
+
# azure_stream_name - string - Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
|
|
497
|
+
# azure_oauth_client_credentials_tenant_id - string - Applicable only for destination type: azure. Client Credentials OAuth Tenant ID.
|
|
498
|
+
# azure_oauth_client_credentials_client_id - string - Applicable only for destination type: azure. Client Credentials OAuth Client ID.
|
|
499
|
+
# azure_oauth_client_credentials_client_secret - string - Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
|
|
500
|
+
# qradar_username - string - Applicable only for destination type: qradar. Basic auth username provided by QRadar.
|
|
501
|
+
# qradar_password - string - Applicable only for destination type: qradar. Basic auth password provided by QRadar.
|
|
502
|
+
# solar_winds_token - string - Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
|
|
503
|
+
# new_relic_api_key - string - Applicable only for destination type: new_relic. API key provided by New Relic.
|
|
504
|
+
# datadog_api_key - string - Applicable only for destination type: datadog. API key provided by Datadog.
|
|
505
|
+
# sftp_action_send_enabled - boolean - Whether or not sending is enabled for sftp_action logs.
|
|
506
|
+
# ftp_action_send_enabled - boolean - Whether or not sending is enabled for ftp_action logs.
|
|
507
|
+
# web_dav_action_send_enabled - boolean - Whether or not sending is enabled for web_dav_action logs.
|
|
508
|
+
# sync_send_enabled - boolean - Whether or not sending is enabled for sync logs.
|
|
509
|
+
# outbound_connection_send_enabled - boolean - Whether or not sending is enabled for outbound_connection logs.
|
|
510
|
+
# automation_send_enabled - boolean - Whether or not sending is enabled for automation logs.
|
|
511
|
+
# api_request_send_enabled - boolean - Whether or not sending is enabled for api_request logs.
|
|
512
|
+
# public_hosting_request_send_enabled - boolean - Whether or not sending is enabled for public_hosting_request logs.
|
|
513
|
+
# email_send_enabled - boolean - Whether or not sending is enabled for email logs.
|
|
514
|
+
# exavault_api_request_send_enabled - boolean - Whether or not sending is enabled for exavault_api_request logs.
|
|
515
|
+
# destination_type - string - Destination Type
|
|
516
|
+
# destination_url - string - Destination Url
|
|
517
|
+
def update(params = {})
|
|
518
|
+
params ||= {}
|
|
519
|
+
params[:id] = @attributes[:id]
|
|
520
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
521
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
522
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
523
|
+
raise InvalidParameterError.new("Bad parameter: generic_payload_type must be an String") if params[:generic_payload_type] and !params[:generic_payload_type].is_a?(String)
|
|
524
|
+
raise InvalidParameterError.new("Bad parameter: splunk_token must be an String") if params[:splunk_token] and !params[:splunk_token].is_a?(String)
|
|
525
|
+
raise InvalidParameterError.new("Bad parameter: azure_dcr_immutable_id must be an String") if params[:azure_dcr_immutable_id] and !params[:azure_dcr_immutable_id].is_a?(String)
|
|
526
|
+
raise InvalidParameterError.new("Bad parameter: azure_stream_name must be an String") if params[:azure_stream_name] and !params[:azure_stream_name].is_a?(String)
|
|
527
|
+
raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_tenant_id must be an String") if params[:azure_oauth_client_credentials_tenant_id] and !params[:azure_oauth_client_credentials_tenant_id].is_a?(String)
|
|
528
|
+
raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_id must be an String") if params[:azure_oauth_client_credentials_client_id] and !params[:azure_oauth_client_credentials_client_id].is_a?(String)
|
|
529
|
+
raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_secret must be an String") if params[:azure_oauth_client_credentials_client_secret] and !params[:azure_oauth_client_credentials_client_secret].is_a?(String)
|
|
530
|
+
raise InvalidParameterError.new("Bad parameter: qradar_username must be an String") if params[:qradar_username] and !params[:qradar_username].is_a?(String)
|
|
531
|
+
raise InvalidParameterError.new("Bad parameter: qradar_password must be an String") if params[:qradar_password] and !params[:qradar_password].is_a?(String)
|
|
532
|
+
raise InvalidParameterError.new("Bad parameter: solar_winds_token must be an String") if params[:solar_winds_token] and !params[:solar_winds_token].is_a?(String)
|
|
533
|
+
raise InvalidParameterError.new("Bad parameter: new_relic_api_key must be an String") if params[:new_relic_api_key] and !params[:new_relic_api_key].is_a?(String)
|
|
534
|
+
raise InvalidParameterError.new("Bad parameter: datadog_api_key must be an String") if params[:datadog_api_key] and !params[:datadog_api_key].is_a?(String)
|
|
535
|
+
raise InvalidParameterError.new("Bad parameter: destination_type must be an String") if params[:destination_type] and !params[:destination_type].is_a?(String)
|
|
536
|
+
raise InvalidParameterError.new("Bad parameter: destination_url must be an String") if params[:destination_url] and !params[:destination_url].is_a?(String)
|
|
537
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
538
|
+
|
|
539
|
+
Api.send_request("/siem_http_destinations/#{@attributes[:id]}", :patch, params, @options)
|
|
540
|
+
end
|
|
541
|
+
|
|
542
|
+
def delete(params = {})
|
|
543
|
+
params ||= {}
|
|
544
|
+
params[:id] = @attributes[:id]
|
|
545
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
546
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
547
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
548
|
+
|
|
549
|
+
Api.send_request("/siem_http_destinations/#{@attributes[:id]}", :delete, params, @options)
|
|
550
|
+
end
|
|
551
|
+
|
|
552
|
+
def destroy(params = {})
|
|
553
|
+
delete(params)
|
|
554
|
+
nil
|
|
555
|
+
end
|
|
556
|
+
|
|
557
|
+
def save
|
|
558
|
+
if @attributes[:id]
|
|
559
|
+
new_obj = update(@attributes)
|
|
560
|
+
else
|
|
561
|
+
new_obj = SiemHttpDestination.create(@attributes, @options)
|
|
562
|
+
end
|
|
563
|
+
|
|
564
|
+
@attributes = new_obj.attributes
|
|
565
|
+
true
|
|
566
|
+
end
|
|
567
|
+
|
|
568
|
+
# Parameters:
|
|
569
|
+
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
570
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
571
|
+
def self.list(params = {}, options = {})
|
|
572
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
573
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
574
|
+
|
|
575
|
+
List.new(SiemHttpDestination, params) do
|
|
576
|
+
Api.send_request("/siem_http_destinations", :get, params, options)
|
|
577
|
+
end
|
|
578
|
+
end
|
|
579
|
+
|
|
580
|
+
def self.all(params = {}, options = {})
|
|
581
|
+
list(params, options)
|
|
582
|
+
end
|
|
583
|
+
|
|
584
|
+
# Parameters:
|
|
585
|
+
# id (required) - int64 - Siem Http Destination ID.
|
|
586
|
+
def self.find(id, params = {}, options = {})
|
|
587
|
+
params ||= {}
|
|
588
|
+
params[:id] = id
|
|
589
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
590
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
591
|
+
|
|
592
|
+
response, options = Api.send_request("/siem_http_destinations/#{params[:id]}", :get, params, options)
|
|
593
|
+
SiemHttpDestination.new(response.data, options)
|
|
594
|
+
end
|
|
595
|
+
|
|
596
|
+
def self.get(id, params = {}, options = {})
|
|
597
|
+
find(id, params, options)
|
|
598
|
+
end
|
|
599
|
+
|
|
600
|
+
# Parameters:
|
|
601
|
+
# name - string - Name for this Destination
|
|
602
|
+
# additional_headers - object - Additional HTTP Headers included in calls to the destination URL
|
|
603
|
+
# sending_active - boolean - Whether this SIEM HTTP Destination is currently being sent to or not
|
|
604
|
+
# generic_payload_type - 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.
|
|
605
|
+
# splunk_token - string - Applicable only for destination type: splunk. Authentication token provided by Splunk.
|
|
606
|
+
# azure_dcr_immutable_id - string - Applicable only for destination type: azure. Immutable ID of the Data Collection Rule.
|
|
607
|
+
# azure_stream_name - string - Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
|
|
608
|
+
# azure_oauth_client_credentials_tenant_id - string - Applicable only for destination type: azure. Client Credentials OAuth Tenant ID.
|
|
609
|
+
# azure_oauth_client_credentials_client_id - string - Applicable only for destination type: azure. Client Credentials OAuth Client ID.
|
|
610
|
+
# azure_oauth_client_credentials_client_secret - string - Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
|
|
611
|
+
# qradar_username - string - Applicable only for destination type: qradar. Basic auth username provided by QRadar.
|
|
612
|
+
# qradar_password - string - Applicable only for destination type: qradar. Basic auth password provided by QRadar.
|
|
613
|
+
# solar_winds_token - string - Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
|
|
614
|
+
# new_relic_api_key - string - Applicable only for destination type: new_relic. API key provided by New Relic.
|
|
615
|
+
# datadog_api_key - string - Applicable only for destination type: datadog. API key provided by Datadog.
|
|
616
|
+
# sftp_action_send_enabled - boolean - Whether or not sending is enabled for sftp_action logs.
|
|
617
|
+
# ftp_action_send_enabled - boolean - Whether or not sending is enabled for ftp_action logs.
|
|
618
|
+
# web_dav_action_send_enabled - boolean - Whether or not sending is enabled for web_dav_action logs.
|
|
619
|
+
# sync_send_enabled - boolean - Whether or not sending is enabled for sync logs.
|
|
620
|
+
# outbound_connection_send_enabled - boolean - Whether or not sending is enabled for outbound_connection logs.
|
|
621
|
+
# automation_send_enabled - boolean - Whether or not sending is enabled for automation logs.
|
|
622
|
+
# api_request_send_enabled - boolean - Whether or not sending is enabled for api_request logs.
|
|
623
|
+
# public_hosting_request_send_enabled - boolean - Whether or not sending is enabled for public_hosting_request logs.
|
|
624
|
+
# email_send_enabled - boolean - Whether or not sending is enabled for email logs.
|
|
625
|
+
# exavault_api_request_send_enabled - boolean - Whether or not sending is enabled for exavault_api_request logs.
|
|
626
|
+
# destination_type (required) - string - Destination Type
|
|
627
|
+
# destination_url (required) - string - Destination Url
|
|
628
|
+
def self.create(params = {}, options = {})
|
|
629
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
630
|
+
raise InvalidParameterError.new("Bad parameter: additional_headers must be an Hash") if params[:additional_headers] and !params[:additional_headers].is_a?(Hash)
|
|
631
|
+
raise InvalidParameterError.new("Bad parameter: generic_payload_type must be an String") if params[:generic_payload_type] and !params[:generic_payload_type].is_a?(String)
|
|
632
|
+
raise InvalidParameterError.new("Bad parameter: splunk_token must be an String") if params[:splunk_token] and !params[:splunk_token].is_a?(String)
|
|
633
|
+
raise InvalidParameterError.new("Bad parameter: azure_dcr_immutable_id must be an String") if params[:azure_dcr_immutable_id] and !params[:azure_dcr_immutable_id].is_a?(String)
|
|
634
|
+
raise InvalidParameterError.new("Bad parameter: azure_stream_name must be an String") if params[:azure_stream_name] and !params[:azure_stream_name].is_a?(String)
|
|
635
|
+
raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_tenant_id must be an String") if params[:azure_oauth_client_credentials_tenant_id] and !params[:azure_oauth_client_credentials_tenant_id].is_a?(String)
|
|
636
|
+
raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_id must be an String") if params[:azure_oauth_client_credentials_client_id] and !params[:azure_oauth_client_credentials_client_id].is_a?(String)
|
|
637
|
+
raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_secret must be an String") if params[:azure_oauth_client_credentials_client_secret] and !params[:azure_oauth_client_credentials_client_secret].is_a?(String)
|
|
638
|
+
raise InvalidParameterError.new("Bad parameter: qradar_username must be an String") if params[:qradar_username] and !params[:qradar_username].is_a?(String)
|
|
639
|
+
raise InvalidParameterError.new("Bad parameter: qradar_password must be an String") if params[:qradar_password] and !params[:qradar_password].is_a?(String)
|
|
640
|
+
raise InvalidParameterError.new("Bad parameter: solar_winds_token must be an String") if params[:solar_winds_token] and !params[:solar_winds_token].is_a?(String)
|
|
641
|
+
raise InvalidParameterError.new("Bad parameter: new_relic_api_key must be an String") if params[:new_relic_api_key] and !params[:new_relic_api_key].is_a?(String)
|
|
642
|
+
raise InvalidParameterError.new("Bad parameter: datadog_api_key must be an String") if params[:datadog_api_key] and !params[:datadog_api_key].is_a?(String)
|
|
643
|
+
raise InvalidParameterError.new("Bad parameter: destination_type must be an String") if params[:destination_type] and !params[:destination_type].is_a?(String)
|
|
644
|
+
raise InvalidParameterError.new("Bad parameter: destination_url must be an String") if params[:destination_url] and !params[:destination_url].is_a?(String)
|
|
645
|
+
raise MissingParameterError.new("Parameter missing: destination_type") unless params[:destination_type]
|
|
646
|
+
raise MissingParameterError.new("Parameter missing: destination_url") unless params[:destination_url]
|
|
647
|
+
|
|
648
|
+
response, options = Api.send_request("/siem_http_destinations", :post, params, options)
|
|
649
|
+
SiemHttpDestination.new(response.data, options)
|
|
650
|
+
end
|
|
651
|
+
|
|
652
|
+
# Parameters:
|
|
653
|
+
# siem_http_destination_id - int64 - SIEM HTTP Destination ID
|
|
654
|
+
# destination_type - string - Destination Type
|
|
655
|
+
# destination_url - string - Destination Url
|
|
656
|
+
# name - string - Name for this Destination
|
|
657
|
+
# additional_headers - object - Additional HTTP Headers included in calls to the destination URL
|
|
658
|
+
# sending_active - boolean - Whether this SIEM HTTP Destination is currently being sent to or not
|
|
659
|
+
# generic_payload_type - 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.
|
|
660
|
+
# splunk_token - string - Applicable only for destination type: splunk. Authentication token provided by Splunk.
|
|
661
|
+
# azure_dcr_immutable_id - string - Applicable only for destination type: azure. Immutable ID of the Data Collection Rule.
|
|
662
|
+
# azure_stream_name - string - Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
|
|
663
|
+
# azure_oauth_client_credentials_tenant_id - string - Applicable only for destination type: azure. Client Credentials OAuth Tenant ID.
|
|
664
|
+
# azure_oauth_client_credentials_client_id - string - Applicable only for destination type: azure. Client Credentials OAuth Client ID.
|
|
665
|
+
# azure_oauth_client_credentials_client_secret - string - Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
|
|
666
|
+
# qradar_username - string - Applicable only for destination type: qradar. Basic auth username provided by QRadar.
|
|
667
|
+
# qradar_password - string - Applicable only for destination type: qradar. Basic auth password provided by QRadar.
|
|
668
|
+
# solar_winds_token - string - Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
|
|
669
|
+
# new_relic_api_key - string - Applicable only for destination type: new_relic. API key provided by New Relic.
|
|
670
|
+
# datadog_api_key - string - Applicable only for destination type: datadog. API key provided by Datadog.
|
|
671
|
+
# sftp_action_send_enabled - boolean - Whether or not sending is enabled for sftp_action logs.
|
|
672
|
+
# ftp_action_send_enabled - boolean - Whether or not sending is enabled for ftp_action logs.
|
|
673
|
+
# web_dav_action_send_enabled - boolean - Whether or not sending is enabled for web_dav_action logs.
|
|
674
|
+
# sync_send_enabled - boolean - Whether or not sending is enabled for sync logs.
|
|
675
|
+
# outbound_connection_send_enabled - boolean - Whether or not sending is enabled for outbound_connection logs.
|
|
676
|
+
# automation_send_enabled - boolean - Whether or not sending is enabled for automation logs.
|
|
677
|
+
# api_request_send_enabled - boolean - Whether or not sending is enabled for api_request logs.
|
|
678
|
+
# public_hosting_request_send_enabled - boolean - Whether or not sending is enabled for public_hosting_request logs.
|
|
679
|
+
# email_send_enabled - boolean - Whether or not sending is enabled for email logs.
|
|
680
|
+
# exavault_api_request_send_enabled - boolean - Whether or not sending is enabled for exavault_api_request logs.
|
|
681
|
+
def self.send_test_entry(params = {}, options = {})
|
|
682
|
+
raise InvalidParameterError.new("Bad parameter: siem_http_destination_id must be an Integer") if params[:siem_http_destination_id] and !params[:siem_http_destination_id].is_a?(Integer)
|
|
683
|
+
raise InvalidParameterError.new("Bad parameter: destination_type must be an String") if params[:destination_type] and !params[:destination_type].is_a?(String)
|
|
684
|
+
raise InvalidParameterError.new("Bad parameter: destination_url must be an String") if params[:destination_url] and !params[:destination_url].is_a?(String)
|
|
685
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
686
|
+
raise InvalidParameterError.new("Bad parameter: additional_headers must be an Hash") if params[:additional_headers] and !params[:additional_headers].is_a?(Hash)
|
|
687
|
+
raise InvalidParameterError.new("Bad parameter: generic_payload_type must be an String") if params[:generic_payload_type] and !params[:generic_payload_type].is_a?(String)
|
|
688
|
+
raise InvalidParameterError.new("Bad parameter: splunk_token must be an String") if params[:splunk_token] and !params[:splunk_token].is_a?(String)
|
|
689
|
+
raise InvalidParameterError.new("Bad parameter: azure_dcr_immutable_id must be an String") if params[:azure_dcr_immutable_id] and !params[:azure_dcr_immutable_id].is_a?(String)
|
|
690
|
+
raise InvalidParameterError.new("Bad parameter: azure_stream_name must be an String") if params[:azure_stream_name] and !params[:azure_stream_name].is_a?(String)
|
|
691
|
+
raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_tenant_id must be an String") if params[:azure_oauth_client_credentials_tenant_id] and !params[:azure_oauth_client_credentials_tenant_id].is_a?(String)
|
|
692
|
+
raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_id must be an String") if params[:azure_oauth_client_credentials_client_id] and !params[:azure_oauth_client_credentials_client_id].is_a?(String)
|
|
693
|
+
raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_secret must be an String") if params[:azure_oauth_client_credentials_client_secret] and !params[:azure_oauth_client_credentials_client_secret].is_a?(String)
|
|
694
|
+
raise InvalidParameterError.new("Bad parameter: qradar_username must be an String") if params[:qradar_username] and !params[:qradar_username].is_a?(String)
|
|
695
|
+
raise InvalidParameterError.new("Bad parameter: qradar_password must be an String") if params[:qradar_password] and !params[:qradar_password].is_a?(String)
|
|
696
|
+
raise InvalidParameterError.new("Bad parameter: solar_winds_token must be an String") if params[:solar_winds_token] and !params[:solar_winds_token].is_a?(String)
|
|
697
|
+
raise InvalidParameterError.new("Bad parameter: new_relic_api_key must be an String") if params[:new_relic_api_key] and !params[:new_relic_api_key].is_a?(String)
|
|
698
|
+
raise InvalidParameterError.new("Bad parameter: datadog_api_key must be an String") if params[:datadog_api_key] and !params[:datadog_api_key].is_a?(String)
|
|
699
|
+
|
|
700
|
+
Api.send_request("/siem_http_destinations/send_test_entry", :post, params, options)
|
|
701
|
+
nil
|
|
702
|
+
end
|
|
703
|
+
|
|
704
|
+
# Parameters:
|
|
705
|
+
# name - string - Name for this Destination
|
|
706
|
+
# additional_headers - object - Additional HTTP Headers included in calls to the destination URL
|
|
707
|
+
# sending_active - boolean - Whether this SIEM HTTP Destination is currently being sent to or not
|
|
708
|
+
# generic_payload_type - 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.
|
|
709
|
+
# splunk_token - string - Applicable only for destination type: splunk. Authentication token provided by Splunk.
|
|
710
|
+
# azure_dcr_immutable_id - string - Applicable only for destination type: azure. Immutable ID of the Data Collection Rule.
|
|
711
|
+
# azure_stream_name - string - Applicable only for destination type: azure. Name of the stream in the DCR that represents the destination table.
|
|
712
|
+
# azure_oauth_client_credentials_tenant_id - string - Applicable only for destination type: azure. Client Credentials OAuth Tenant ID.
|
|
713
|
+
# azure_oauth_client_credentials_client_id - string - Applicable only for destination type: azure. Client Credentials OAuth Client ID.
|
|
714
|
+
# azure_oauth_client_credentials_client_secret - string - Applicable only for destination type: azure. Client Credentials OAuth Client Secret.
|
|
715
|
+
# qradar_username - string - Applicable only for destination type: qradar. Basic auth username provided by QRadar.
|
|
716
|
+
# qradar_password - string - Applicable only for destination type: qradar. Basic auth password provided by QRadar.
|
|
717
|
+
# solar_winds_token - string - Applicable only for destination type: solar_winds. Authentication token provided by Solar Winds.
|
|
718
|
+
# new_relic_api_key - string - Applicable only for destination type: new_relic. API key provided by New Relic.
|
|
719
|
+
# datadog_api_key - string - Applicable only for destination type: datadog. API key provided by Datadog.
|
|
720
|
+
# sftp_action_send_enabled - boolean - Whether or not sending is enabled for sftp_action logs.
|
|
721
|
+
# ftp_action_send_enabled - boolean - Whether or not sending is enabled for ftp_action logs.
|
|
722
|
+
# web_dav_action_send_enabled - boolean - Whether or not sending is enabled for web_dav_action logs.
|
|
723
|
+
# sync_send_enabled - boolean - Whether or not sending is enabled for sync logs.
|
|
724
|
+
# outbound_connection_send_enabled - boolean - Whether or not sending is enabled for outbound_connection logs.
|
|
725
|
+
# automation_send_enabled - boolean - Whether or not sending is enabled for automation logs.
|
|
726
|
+
# api_request_send_enabled - boolean - Whether or not sending is enabled for api_request logs.
|
|
727
|
+
# public_hosting_request_send_enabled - boolean - Whether or not sending is enabled for public_hosting_request logs.
|
|
728
|
+
# email_send_enabled - boolean - Whether or not sending is enabled for email logs.
|
|
729
|
+
# exavault_api_request_send_enabled - boolean - Whether or not sending is enabled for exavault_api_request logs.
|
|
730
|
+
# destination_type - string - Destination Type
|
|
731
|
+
# destination_url - string - Destination Url
|
|
732
|
+
def self.update(id, params = {}, options = {})
|
|
733
|
+
params ||= {}
|
|
734
|
+
params[:id] = id
|
|
735
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
736
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
737
|
+
raise InvalidParameterError.new("Bad parameter: additional_headers must be an Hash") if params[:additional_headers] and !params[:additional_headers].is_a?(Hash)
|
|
738
|
+
raise InvalidParameterError.new("Bad parameter: generic_payload_type must be an String") if params[:generic_payload_type] and !params[:generic_payload_type].is_a?(String)
|
|
739
|
+
raise InvalidParameterError.new("Bad parameter: splunk_token must be an String") if params[:splunk_token] and !params[:splunk_token].is_a?(String)
|
|
740
|
+
raise InvalidParameterError.new("Bad parameter: azure_dcr_immutable_id must be an String") if params[:azure_dcr_immutable_id] and !params[:azure_dcr_immutable_id].is_a?(String)
|
|
741
|
+
raise InvalidParameterError.new("Bad parameter: azure_stream_name must be an String") if params[:azure_stream_name] and !params[:azure_stream_name].is_a?(String)
|
|
742
|
+
raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_tenant_id must be an String") if params[:azure_oauth_client_credentials_tenant_id] and !params[:azure_oauth_client_credentials_tenant_id].is_a?(String)
|
|
743
|
+
raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_id must be an String") if params[:azure_oauth_client_credentials_client_id] and !params[:azure_oauth_client_credentials_client_id].is_a?(String)
|
|
744
|
+
raise InvalidParameterError.new("Bad parameter: azure_oauth_client_credentials_client_secret must be an String") if params[:azure_oauth_client_credentials_client_secret] and !params[:azure_oauth_client_credentials_client_secret].is_a?(String)
|
|
745
|
+
raise InvalidParameterError.new("Bad parameter: qradar_username must be an String") if params[:qradar_username] and !params[:qradar_username].is_a?(String)
|
|
746
|
+
raise InvalidParameterError.new("Bad parameter: qradar_password must be an String") if params[:qradar_password] and !params[:qradar_password].is_a?(String)
|
|
747
|
+
raise InvalidParameterError.new("Bad parameter: solar_winds_token must be an String") if params[:solar_winds_token] and !params[:solar_winds_token].is_a?(String)
|
|
748
|
+
raise InvalidParameterError.new("Bad parameter: new_relic_api_key must be an String") if params[:new_relic_api_key] and !params[:new_relic_api_key].is_a?(String)
|
|
749
|
+
raise InvalidParameterError.new("Bad parameter: datadog_api_key must be an String") if params[:datadog_api_key] and !params[:datadog_api_key].is_a?(String)
|
|
750
|
+
raise InvalidParameterError.new("Bad parameter: destination_type must be an String") if params[:destination_type] and !params[:destination_type].is_a?(String)
|
|
751
|
+
raise InvalidParameterError.new("Bad parameter: destination_url must be an String") if params[:destination_url] and !params[:destination_url].is_a?(String)
|
|
752
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
753
|
+
|
|
754
|
+
response, options = Api.send_request("/siem_http_destinations/#{params[:id]}", :patch, params, options)
|
|
755
|
+
SiemHttpDestination.new(response.data, options)
|
|
756
|
+
end
|
|
757
|
+
|
|
758
|
+
def self.delete(id, params = {}, options = {})
|
|
759
|
+
params ||= {}
|
|
760
|
+
params[:id] = id
|
|
761
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
762
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
763
|
+
|
|
764
|
+
Api.send_request("/siem_http_destinations/#{params[:id]}", :delete, params, options)
|
|
765
|
+
nil
|
|
766
|
+
end
|
|
767
|
+
|
|
768
|
+
def self.destroy(id, params = {}, options = {})
|
|
769
|
+
delete(id, params, options)
|
|
770
|
+
nil
|
|
771
|
+
end
|
|
772
|
+
end
|
|
773
|
+
end
|
data/lib/files.com/version.rb
CHANGED
data/lib/files.com.rb
CHANGED
|
@@ -113,6 +113,7 @@ require "files.com/models/sftp_action_log"
|
|
|
113
113
|
require "files.com/models/sftp_host_key"
|
|
114
114
|
require "files.com/models/share_group"
|
|
115
115
|
require "files.com/models/share_group_member"
|
|
116
|
+
require "files.com/models/siem_http_destination"
|
|
116
117
|
require "files.com/models/site"
|
|
117
118
|
require "files.com/models/snapshot"
|
|
118
119
|
require "files.com/models/sso_strategy"
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: files.com
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.1.
|
|
4
|
+
version: 1.1.133
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- files.com
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2024-09-
|
|
11
|
+
date: 2024-09-19 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|
|
@@ -196,6 +196,7 @@ files:
|
|
|
196
196
|
- docs/sftp_host_key.md
|
|
197
197
|
- docs/share_group.md
|
|
198
198
|
- docs/share_group_member.md
|
|
199
|
+
- docs/siem_http_destination.md
|
|
199
200
|
- docs/site.md
|
|
200
201
|
- docs/snapshot.md
|
|
201
202
|
- docs/sso_strategy.md
|
|
@@ -298,6 +299,7 @@ files:
|
|
|
298
299
|
- lib/files.com/models/sftp_host_key.rb
|
|
299
300
|
- lib/files.com/models/share_group.rb
|
|
300
301
|
- lib/files.com/models/share_group_member.rb
|
|
302
|
+
- lib/files.com/models/siem_http_destination.rb
|
|
301
303
|
- lib/files.com/models/site.rb
|
|
302
304
|
- lib/files.com/models/snapshot.rb
|
|
303
305
|
- lib/files.com/models/sso_strategy.rb
|