ON THIS PAGE
POST /config/event_sources/log_source_management/log_source_groups
SUMMARY Creates a new log source group. 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.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
fields |
header |
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. |
Parameter | Data Type | MIME Type | Description | Sample |
---|---|---|---|---|
log_source_data |
Object |
application/json |
The log source to create. |
{ "description": "String", "name": "String", "parent_id": 42 } |
HTTP Response Code | Unique Code | Description |
---|---|---|
201 |
The log source was created successfully. |
|
403 |
1000 |
The endpoint cannot be used by users associated with a tenant. |
409 |
1001 |
The 'name' parameter must be unique. |
422 |
1002 |
The 'name' parameter is required. |
422 |
1003 |
The 'name' parameter must not exceed 255 characters. |
422 |
1004 |
The 'description' parameter must not exceed 255 characters. |
422 |
1005 |
The parent group was not found. |
500 |
1100 |
An error occurred during the attempt to create the log source. |
Response Description
The newly created log source.
Response Sample
{ "assignable": true, "child_group_ids": [ 42 ], "description": "String", "id": 42, "modification_date": 42, "name": "String", "owner": "String", "parent_id": 42 }