The configuration API is made available through the configuration endpoint of the Endpoint Security Server REST API. For complete details on how to interact with Endpoint Security Server API, refer to the Endpoint Security REST API Guide
Get IOC Streaming configuration
Returns the current configuration of the IOC Streaming module as a JSON result.
HTTP Verb | Server |
|---|---|
|
|
Parameter | Notes |
|---|---|
| Pulls the IOC Streaming configuration. |
The information that is returned is a JSON dictionary with the following keys:
ResponseKey | Notes |
|---|---|
Data | List of configuration properties. Each property has the following attributes:
|
The following is a list of configuration properties for the IOC Streaming module:
Purpose | Name | Type {Values} |
|---|---|---|
Logging level |
| String {'debug' | 'info' | 'warning' | 'notice' | 'error' | 'critical' | 'alert' | 'emergency'} |
Data Aging monitor |
| Int32 (number of seconds) Default = 1 Day Range: 5 mins to 7 days. Avoid adjusting this value unless directed by support. |
Statistics offset hours |
| Int32 (number of hours) Default = 0 Hours Range: 0 to 23 |
Statistics offset minutes |
| Int32 (number of hours) Default = 0 Minutes Range: 0 to 59 |
Base URL for Helix ingest |
| String, default is empty. Used when the destination environment stack for Helix is not production. For example, when targeting a QA stack, use the value |
Data Aging period |
| Int32: (number of seconds) Default = 30 Days Interval of when an indicator or condition marked for deletion will be removed from the database. By default, an indicator will be removed 30 days after it was marked for deletion. |
.png "ConfAPI_1.png")
.png "ConfAPI_2.png")
Set IOC Streaming configuration
Update a configuration property for the IOC Streaming module. See the list of configuration properties above.
HTTP | Verb Server |
|---|---|
|
|
Query parameters
Parameter | Notes |
|---|---|
| Pulls the IOC Streaming configuration. |
The following header is highlighted to indicate that there will be JSON-formatted request data within the body.
Query headers
Content-Type | Application/JSON |
Query body
Key | Notes | Example Request |
|---|---|---|
| List of configuration properties. Each property has the following attributes:
|
|
Note
This request will not provide feedback in the response if an invalid value is specified. However, when finding an invalid configuration property value, the IOC Streaming module will replace that value with the default value for that property. You cannot modify the default value of a configuration property using this request.