Update case configurations
editUpdate case configurations
editUpdates the connector’s case closure settings.
Console supports only Elasticsearch APIs. Console doesn’t allow interactions with Kibana APIs. You must use curl
or another HTTP tool instead. For more information, refer to Run Elasticsearch API requests.
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 URL
editPATCH <kibana host>:<port>/api/cases/configure/<configuration ID>
URL parts
editThe URL must include the configuration ID
of the configuration (call Get current connector to retrieve the configuration IDs).
Request body
editA JSON object with these fields:
Name | Type | Description | Required |
---|---|---|---|
|
Object containing the connector’s configuration. |
Yes |
|
|
String |
Determines whether a case is automatically closed in Elastic Security when it is pushed to external systems. Valid values are:
|
No |
|
String |
The connector version. |
Yes |
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. |
Yes |
|
String |
The type of the connector. Must be one of these:
|
Yes |
|
Object |
Object containing connector’s fields. For ServiceNow connectors:
For ServiceNow SecOps connectors:
For Jira connectors:
For IBM Resilient connectors:
For Swimlane connectors:
|
Yes |
Call Get current connector to retrieve the version value, and Find connectors to retrieve connector IDs.
Fields can be set but are not being used by case configuration. You can set the fields of the connector at Create case.
Example request
editChanges the connector’s case closure option:
PATCH api/cases/configure/7349772f-421a-4de3-b8bb-2d9b22ccee30 { "connector": { "id": "131d4448-abe0-4789-939d-8ef60680b498", "name": "My connector", "type": ".jira", "fields": null, } "closure_type": "close-by-pushing", "version": "WzIwMiwxXQ==" }
Response code
edit-
200
- Indicates a successful call.
Example response
edit{ "connector": { "id": "131d4448-abe0-4789-939d-8ef60680b498", "name": "My connector", "type": ".jira", "fields": null, }, "closure_type": "close-by-pushing", "created_at": "2020-03-30T13:31:38.083Z", "created_by": { "email": "admin@hms.gov.uk", "full_name": "Ms Admin", "username": "admin" }, "error": null, "id": "7349772f-421a-4de3-b8bb-2d9b22ccee30", "owner": "securitySolution", "updated_at": "2020-03-31T06:21:35.759Z", "updated_by": { "email": "admin@hms.gov.uk", "full_name": "Ms Admin", "username": "admin" }, "version": "WzIwMywxXQ==" }