JSA Risk Manager Endpoints

Use the references for REST API V9.0 JSA Risk Manager endpoints.

GET /qrm/model_groups

Retrieves a list of model groups.

Table 1: GET /qrm/model_groups Resource Details

MIME Type
application/json

Table 2: GET /qrm/model_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.
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.
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 /qrm/model_groups Response Codes

HTTP Response Code	Unique Code	Description
200		The model groups were retrieved.
500	1020	An error occurred during the attempt to retrieve the model groups.

Response Description

List of the Group objects. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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>" } ]

GET /qrm/model_groups/{group_id}

Retrieves a model group.

Table 4: GET /qrm/model_groups/{group_id} Resource Details

MIME Type
application/json

Table 5: GET /qrm/model_groups/{group_id} Request Parameter Details

Parameter	Type	Optionality	Data Type	MIME Type	Description
group_id	path	Required	Number (Integer)	text/plain	null
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 6: GET /qrm/model_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
200		The model group was retrieved.
404	1002	The model group does not exist.
500	1020	An error occurred during the attempt to retrieve the model group.

Response Description

A single Group object. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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>" }

POST /qrm/model_groups/{group_id}

Updates the owner of a model group.

Table 7: POST /qrm/model_groups/{group_id} Resource Details

MIME Type
application/json

Table 8: POST /qrm/model_groups/{group_id} Request Parameter Details

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.

Table 9: POST /qrm/model_groups/{group_id} Request Body Details

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>" }

Table 10: POST /qrm/model_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
200		The model group was updated.
404	1002	The model group does not exist.
409	1004	The provided user does not have the required capabilities to own the model group.
422	1005	A request parameter is not valid.
500	1020	An error occurred during the attempt to update the model group.

Response Description

The updated Group object. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

DELETE /qrm/model_groups/{group_id}

Deletes a model group.

Table 11: DELETE /qrm/model_groups/{group_id} Resource Details

MIME Type
text/plain

Table 12: DELETE /qrm/model_groups/{group_id} Request Parameter Details

Parameter	Type	Optionality	Data Type	MIME Type	Description
group_id	path	Required	Number (Integer)	text/plain	null

Table 13: DELETE /qrm/model_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
204		The model group was deleted.
404	1002	The model group does not exist.
409	1004	null
500	1020	An error occurred during the attempt to delete the model group.

Response Description

Response Sample

GET /qrm/qrm_saved_search_groups

Retrieves a list of QRM saved search groups.

Table 14: GET /qrm/qrm_saved_search_groups Resource Details

MIME Type
application/json

Table 15: GET /qrm/qrm_saved_search_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.
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.
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 16: GET /qrm/qrm_saved_search_groups Response Codes

HTTP Response Code	Unique Code	Description
200		The QRM saved search groups were returned.
500	1020	An error occurred during the attempt to retrieve the QRM saved search groups.

Response Description

List of the Group objects. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

GET /qrm/qrm_saved_search_groups/{group_id}

Retrieves a QRM saved search group.

Table 17: GET /qrm/qrm_saved_search_groups/{group_id} Resource Details

MIME Type
application/json

Table 18: GET /qrm/qrm_saved_search_groups/{group_id} Request Parameter Details

Parameter	Type	Optionality	Data Type	MIME Type	Description
group_id	path	Required	Number (Integer)	text/plain	null
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 19: GET /qrm/qrm_saved_search_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
200		The QRM saved search group was retrieved.
404	1002	The QRM saved search group does not exist.
500	1020	An error occurred during the attempt to retrieve the QRM saved search group.

Response Description

A single Group object. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

POST /qrm/qrm_saved_search_groups/{group_id}

Updates the owner of a QRM saved search group.

Table 20: POST /qrm/qrm_saved_search_groups/{group_id} Resource Details

MIME Type
application/json

Table 21: POST /qrm/qrm_saved_search_groups/{group_id} Request Parameter Details

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.

Table 22: POST /qrm/qrm_saved_search_groups/{group_id} Request Body Details

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>" }

Table 23: POST /qrm/qrm_saved_search_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
200		The QRM saved search group was updated.
404	1002	The QRM saved search group does not exist.
409	1004	The provided user does not have the required capabilities to own the QRM saved search group.
422	1005	A request parameter is not valid.
500	1020	An error occurred during the attempt to update the QRM saved search group.

Response Description

The updated Group object. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

DELETE /qrm/qrm_saved_search_groups/{group_id}

Deletes a QRM saved search group.

Table 24: DELETE /qrm/qrm_saved_search_groups/{group_id} Resource Details

MIME Type
text/plain

Table 25: DELETE /qrm/qrm_saved_search_groups/{group_id} Request Parameter Details

Parameter	Type	Optionality	Data Type	MIME Type	Description
group_id	path	Required	Number (Integer)	text/plain	null

Table 26: DELETE /qrm/qrm_saved_search_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
204		The QRM saved search group was deleted.
404	1002	The QRM saved search group does not exist.
409	1004	null
500	1020	An error occurred during the attempt to delete the QRM saved search group.

Response Description

Response Sample

GET /qrm/question_groups

Retrieves a list of question groups.

Table 27: GET /qrm/question_groups Resource Details

MIME Type
application/json

Table 28: GET /qrm/question_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.
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.
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 29: GET /qrm/question_groups Response Codes

HTTP Response Code	Unique Code	Description
200		The question groups were retrieved.
500	1020	An error occurred during the attempt to retrieve the question groups.

Response Description

List of the Group objects. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

GET /qrm/question_groups/{group_id}

Retrieves a question group.

Table 30: GET /qrm/question_groups/{group_id} Resource Details

MIME Type
application/json

Table 31: GET /qrm/question_groups/{group_id} Request Parameter Details

Parameter	Type	Optionality	Data Type	MIME Type	Description
group_id	path	Required	Number (Integer)	text/plain	null
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 32: GET /qrm/question_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
200		The question group was retrieved.
404	1002	The question group does not exist.
500	1020	An error occurred during the attempt to retrieve the question group.

Response Description

A single Group object. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

POST /qrm/question_groups/{group_id}

Updates the owner of a question group.

Table 33: POST /qrm/question_groups/{group_id} Resource Details

MIME Type
application/json

Table 34: POST /qrm/question_groups/{group_id} Request Parameter Details

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.

Table 35: POST /qrm/question_groups/{group_id} Request Body Details

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>" }

Table 36: POST /qrm/question_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
200		The question group was updated.
404	1002	The question group does not exist.
409	1004	The provided user does not have the required capabilities to own the question group.
422	1005	A request parameter is not valid.
500	1020	An error occurred during the attempt to update the question group.

Response Description

The updated Group object. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

DELETE /qrm/question_groups/{group_id}

Deletes a question group.

Table 37: DELETE /qrm/question_groups/{group_id} Resource Details

MIME Type
text/plain

Table 38: DELETE /qrm/question_groups/{group_id} Request Parameter Details

Parameter	Type	Optionality	Data Type	MIME Type	Description
group_id	path	Required	Number (Integer)	text/plain	null

Table 39: DELETE /qrm/question_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
204		The question group was deleted.
404	1002	The question group does not exist.
409	1004	null
500	1020	An error occurred during the attempt to delete the question group.

Response Description

Response Sample

GET /qrm/simulation_groups

Retrieves a of list the simulation groups.

Table 40: GET /qrm/simulation_groups Resource Details

MIME Type
application/json

Table 41: GET /qrm/simulation_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.
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.
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 42: GET /qrm/simulation_groups Response Codes

HTTP Response Code	Unique Code	Description
200		The simulation groups were retrieved.
500	1020	An error occurred during the attempt to retrieve the simulation groups.

Response Description

List of the Group objects. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

GET /qrm/simulation_groups/{group_id}

Retrieves a simulation group.

Table 43: GET /qrm/simulation_groups/{group_id} Resource Details

MIME Type
application/json

Table 44: GET /qrm/simulation_groups/{group_id} Request Parameter Details

Parameter	Type	Optionality	Data Type	MIME Type	Description
group_id	path	Required	Number (Integer)	text/plain	null
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 45: GET /qrm/simulation_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
200		The simulation group were retrieved.
404	1002	The simulation group does not exist.
500	1020	An error occurred during the attempt to retrieve the simulation group.

Response Description

A single Group object. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

POST /qrm/simulation_groups/{group_id}

Updates the owner of a simulation group.

Table 46: POST /qrm/simulation_groups/{group_id} Resource Details

MIME Type
application/json

Table 47: POST /qrm/simulation_groups/{group_id} Request Parameter Details

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.

Table 48: POST /qrm/simulation_groups/{group_id} Request Body Details

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>" }

Table 49: POST /qrm/simulation_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
200		The simulation group was updated.
404	1002	The simulation group does not exist.
409	1004	The provided user does not have the required capabilities to own the simulation group.
422	1005	A request parameter is not valid.
500	1020	An error occurred during the attempt to update the simulation group.

Response Description

The updated Group object. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

DELETE /qrm/simulation_groups/{group_id}

Deletes a simulation group.

Table 50: DELETE /qrm/simulation_groups/{group_id} Resource Details

MIME Type
text/plain

Table 51: DELETE /qrm/simulation_groups/{group_id} Request Parameter Details

Parameter	Type	Optionality	Data Type	MIME Type	Description
group_id	path	Required	Number (Integer)	text/plain	null

Table 52: DELETE /qrm/simulation_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
204		The simulation group has been deleted.
404	1002	The simulation group does not exist.
409	1004	null
500	1020	An error occurred during the attempt to delete the simulation group.

Response Description

Response Sample

GET /qrm/topology_saved_search_groups

Retrieves a list of topology saved search groups.

Table 53: GET /qrm/topology_saved_search_groups Resource Details

MIME Type
application/json

Table 54: GET /qrm/topology_saved_search_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.
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.
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 55: GET /qrm/topology_saved_search_groups Response Codes

HTTP Response Code	Unique Code	Description
200		The topology saved search groups were returned.
500	1020	An error occurred during the attempt to retrieve the topology saved search groups.

Response Description

List of the Group objects. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

GET /qrm/topology_saved_search_groups/{group_id}

Retrieves a topology saved search group.

Table 56: GET /qrm/topology_saved_search_groups/{group_id} Resource Details

MIME Type
application/json

Table 57: GET /qrm/topology_saved_search_groups/{group_id} Request Parameter Details

Parameter	Type	Optionality	Data Type	MIME Type	Description
group_id	path	Required	Number (Integer)	text/plain	null
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 58: GET /qrm/topology_saved_search_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
200		The topology saved search group was retrieved.
404	1002	The topology saved search group does not exist.
500	1020	An error occurred during the attempt to retrieve the topology saved search group.

Response Description

A single Group object. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

POST /qrm/topology_saved_search_groups/{group_id}

Updates the owner of an topology saved search group.

Table 59: POST /qrm/topology_saved_search_groups/{group_id} Resource Details

MIME Type
application/json

Table 60: POST /qrm/topology_saved_search_groups/{group_id} Request Parameter Details

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.

Table 61: POST /qrm/topology_saved_search_groups/{group_id} Request Body Details

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>" }

Table 62: POST /qrm/topology_saved_search_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
200		The topology saved search group was updated.
404	1002	The topology saved search group does not exist.
409	1004	The provided user does not have the required capabilities to own the topology saved search group.
422	1005	A request parameter is not valid.
500	1020	An error occurred during the attempt to update the topology saved search group.

Response Description

The updated Group object. A Group object contains the following fields:

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 groups can have localized names).
description - String - The description of the group (default groups 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

DELETE /qrm/topology_saved_search_groups/{group_id}

Deletes a topology saved search group.

Table 63: DELETE /qrm/topology_saved_search_groups/{group_id} Resource Details

MIME Type
text/plain

Table 64: DELETE /qrm/topology_saved_search_groups/{group_id} Request Parameter Details

Parameter	Type	Optionality	Data Type	MIME Type	Description
group_id	path	Required	Number (Integer)	text/plain	null

Table 65: DELETE /qrm/topology_saved_search_groups/{group_id} Response Codes

HTTP Response Code	Unique Code	Description
204		The topology saved search group was deleted.
404	1002	The topology saved search group does not exist.
409	1004	null
500	1020	An error occurred during the attempt to delete the topology saved search group.

JSA Risk Manager Endpoints

GET /qrm/model_groups

Response Description

Response Sample

GET /qrm/model_groups/{group_id}

Response Description

Response Sample

POST /qrm/model_groups/{group_id}

Response Description

Response Sample

DELETE /qrm/model_groups/{group_id}

Response Description

Response Sample

GET /qrm/qrm_saved_search_groups

Response Description

Response Sample

GET /qrm/qrm_saved_search_groups/{group_id}

Response Description

Response Sample

POST /qrm/qrm_saved_search_groups/{group_id}

Response Description

Response Sample

DELETE /qrm/qrm_saved_search_groups/{group_id}

Response Description

Response Sample

GET /qrm/question_groups

Response Description

Response Sample

GET /qrm/question_groups/{group_id}

Response Description

Response Sample

POST /qrm/question_groups/{group_id}

Response Description

Response Sample

DELETE /qrm/question_groups/{group_id}

Response Description

Response Sample

GET /qrm/simulation_groups

Response Description

Response Sample

GET /qrm/simulation_groups/{group_id}

Response Description

Response Sample

POST /qrm/simulation_groups/{group_id}

Response Description

Response Sample

DELETE /qrm/simulation_groups/{group_id}

Response Description

Response Sample

GET /qrm/topology_saved_search_groups

Response Description

Response Sample

GET /qrm/topology_saved_search_groups/{group_id}

Response Description

Response Sample

POST /qrm/topology_saved_search_groups/{group_id}

Response Description

Response Sample

DELETE /qrm/topology_saved_search_groups/{group_id}

Response Description

Response Sample

Related Documentation