ON THIS PAGE
POST /analytics/rule_groups/{group_id}
SUMMARY Updates the owner of a rule group.
Updates the owner of a rule group.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
group_id |
path |
Required |
Number (Integer) |
text/plain |
null |
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 |
---|---|---|---|---|
group |
Object |
application/json |
Required - Group object with the owner set to a valid deployed user. |
{ "child_groups": [ 42 ], "child_items": [ "String" ], "description": "String", "id": 42, "level": 42, "name": "String", "owner": "String", "parent_id": 42, "type": "String <one of: LOG_SOURCE_GROUP, REPORT_GROUP, RULE_GROUP, EVENT_SAVED_SEARCH_GROUP, FLOW_SAVED_SEARCH_GROUP, OFFENSE_SAVED_SEARCH_GROUP, QRM_SAVED_SEARCH_GROUP, MODEL_SAVED_SEARCH_GROUP, QUESTION_SAVED_SEARCH_GROUP, SIMULATION_SAVED_SEARCH_GROUP, TOPOLOGY_SAVED_SEARCH_GROUP, ASSET_SAVED_SEARCH_GROUP, VULNERABILITY_SAVED_SEARCH_GROUP>" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The rule group was updated. |
|
404 |
1002 |
The rule group does not exist. |
409 |
1004 |
The provided user does not have the required capabilities to own the rule group. |
422 |
1005 |
A request parameter is not valid. |
500 |
1020 |
An error occurred during the attempt to update the rule group. |
Response Description
- id - Long - The ID of the group.
- parent_id - Long - The ID of the parent group (default resources can have localized names).
- type - String - The type of the group.
- level - Long - The depth of the group in the group hierarchy.
- name - String - The name of the group (default resources can have localized names).
- description - String - The description of the group (default resources can have localized names).
- owner - String - The owner of the group.
- modified_time - Long - The time in milliseconds since epoch since the group was last modified.
- child_group_ids - Array of Longs - List of the child group IDs.
Response Sample
{ "child_groups": [ 42 ], "child_items": [ "String" ], "description": "String", "id": 42, "level": 42, "modified_time": 42, "name": "String", "owner": "String", "parent_id": 42, "type": "String <one of: LOG_SOURCE_GROUP, REPORT_GROUP, RULE_GROUP, EVENT_SAVED_SEARCH_GROUP, FLOW_SAVED_SEARCH_GROUP, OFFENSE_SAVED_SEARCH_GROUP, QRM_SAVED_SEARCH_GROUP, MODEL_SAVED_SEARCH_GROUP, QUESTION_SAVED_SEARCH_GROUP, SIMULATION_SAVED_SEARCH_GROUP, TOPOLOGY_SAVED_SEARCH_GROUP, ASSET_SAVED_SEARCH_GROUP, VULNERABILITY_SAVED_SEARCH_GROUP>" }