IMPORTANT: No additional bug fixes or documentation updates will be released for this version.
Update case configurationsedit
Updates the connector’s case closure settings.
Connectors are used to interface with external systems. You can only call this method after you have created a connector (see Create connector). After a connector has been created and assigned, call Create or update an external incident to send cases to the external system.
Request URLedit
PATCH <kibana host>:<port>/api/cases/configure
Request bodyedit
A JSON object with these fields:
Name | Type | Description | Required |
---|---|---|---|
|
String |
The ID of the connector you want to use for sending cases to external systems. |
Yes |
|
String |
The connector name. |
No |
|
String |
Determines whether a case is automatically closed in the SIEM app when it is pushed to ServiceNow. Valid values are:
|
No |
|
String |
The connector version. |
Yes |
Call Get current connector to retrieve the version value, and Find connectors to retrieve connector IDs.
Example requestedit
Changes the connector’s case closure option:
PATCH api/cases/configure { "connector_id": "131d4448-abe0-4789-939d-8ef60680b498", "closure_type": "close-by-pushing", "version": "WzIwMiwxXQ==" }
Response codeedit
-
200
- Indicates a successful call.
Example responseedit
{ "connector_id": "131d4448-abe0-4789-939d-8ef60680b498", "closure_type": "close-by-pushing", "connector_name": "ServiceNow", "created_at": "2020-03-30T13:31:38.083Z", "created_by": { "email": "admin@hms.gov.uk", "full_name": "Ms Admin", "username": "admin" }, "updated_at": "2020-03-31T06:21:35.759Z", "updated_by": { "email": "admin@hms.gov.uk", "full_name": "Ms Admin", "username": "admin" }, "version": "WzIwMywxXQ==" }