ON THIS PAGE
GET /config/event_sources/property_discovery_profiles
SUMMARY Gets all PropertyDiscoveryProfiles currently in the system.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Range |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
HTTP Response Code | Unique Code | Description |
---|---|---|
500 |
1020 |
An internal server error has occurred. |
Response Description
- id - Integer - The ID of the property discovery profile.
- property_discovery_type - String - The type of property discovery for this profile (JSON or NONE).
- optimized - Boolean - Indicates whether this profile creates custom properties as optimized.
- active - Boolean - Indicates whether this profile is enabled and actively being used.
- threshold - Integer - How many events should be handling creating no custom-properties before this profile becomes inactive.
- log_source_type_id - Integer - The ID of a log-source-type that this profile corresponds to (This is the basic filter property, it must be set for the profile to be used).
- create_for_normalized - Boolean - If false, the property-discovery-engine will NOT create custom properties for any fields that match the name of a normalized system property. If true, it creates the properties, but with identifying tag on the name; for example a field that is called 'username' creates a custom-property that is named 'username_custom'.
Response Sample
[ { "active": true, "create_for_normalized": true, "delimiter": "String", "delimiter_pair": "String", "id": 42, "log_source_type_id": 42, "property_discovery_type": "String", "threshold": 42, "use_for_rule_engine": true } ]