Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

GET /config/event_sources/property_discovery_profiles/{id}

 

Gets a PropertyDiscoveryProfile based on the information supplied by the property_discovery_profile corresponding to the supplied ID.

Table 1: GET /config/event_sources/property_discovery_profiles/{id} Resource Details

MIME Type

application/json

Table 2: GET /config/event_sources/property_discovery_profiles/{id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

id

path

Required

Number (Integer)

text/plain

The ID of the PropertyDiscoveryProfile.

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.

Table 3: GET /config/event_sources/property_discovery_profiles/{id} Response Codes

HTTP Response Code

Unique Code

Description

404

1002

If the supplied id does not correlate to an existing PropertyDiscoveryProfile.

500

1020

An internal server error has occurred.

Response Description

A PropertyDiscoveryProfile corresponding to the supplied ID.

  • 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