Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

GET /config/event_sources/log_source_management/ log_source_groups

 

Retrieves the list of log source groups.

Table 1: GET /config/event_sources/log_source_management/log_source_groups Resource Details

MIME Type

application/json

Table 2: GET /config/event_sources/log_source_management/log_source_groups Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

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.

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.

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.

Table 3: GET /config/event_sources/log_source_management/log_source_groups Response Codes

HTTP Response Code

Unique Code

Description

200

 

The log source groups were retrieved successfully.

500

1020

An error occurred during the attempt to retrieve the log source groups.

Response Description

The list of all log source groups. A log source group contains the following fields:

  • id - Long - The ID of the group.

  • name - String - The name of the group.

  • description - String - The description of the group.

  • parent_id - Long - The ID of the group's parent group. The root node group has a null parent_ID.

  • owner - String - The name of the user who owns the group.

  • modification_date - Long - The date and time (expressed as milliseconds since epoch) that the group was last modified.

  • assignable - Boolean - If log sources can be assigned to this group, the condition is set to 'true'; otherwise, the condition is set to 'false'. Log sources cannot be assigned directly to the "Other" group or to the root log source group node.

  • child_groups - Array<Long> - The list of IDs of any child log source groups that belong to this group.

Response Sample