GET /config/event_sources/log_source_management/log_source_groups/{id}

Retrieves a log source group by ID.

Table 1. GET /config/event_sources/log_source_management/log_source_groups/{id} resource details
MIME Type
application/json

Table 2. GET /config/event_sources/log_source_management/log_source_groups/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	The ID of the log source group to retrieve.
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/log_source_management/log_source_groups/{id} response codes
HTTP Response Code	Unique Code	Description
200		The log source group was retrieved successfully.
404	1002	The log source group ID was not found.
500	1020	An error occurred during the attempt to retrieve the log source group.

Response Description

The log source group after it is retrieved. 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


{
    "assignable": true,
    "child_group_ids": [
        42
    ],
    "description": "String",
    "id": 42,
    "modification_date": 42,
    "name": "String",
    "owner": "String",
    "parent_id": 42
}