Update case configuration APIedit
Updates external connection details, such as the closure type and default connector for cases.
For the most up-to-date API details, refer to the open API specification. For a preview, check out Case APIs.
Requestedit
PATCH <kibana host>:<port>/api/cases/configure/<configuration_id>
PATCH <kibana host>:<port>/s/<space_id>/api/cases/configure/<configuration_id>
Prerequisitesedit
You must have all privileges for the Cases feature in the Management,
Observability, or Security section of the
Kibana feature privileges, depending on the
owner of the case configuration.
Descriptionedit
Connectors are used to interface with external systems. You must create a connector before you can it in your cases. Refer to Add connectors.
Path parametersedit
-
<configuration_id> - The identifier for the configuration. To retrieve the configuration IDs, use Get configuration.
-
<space_id> - (Optional, string) An identifier for the space. If it is not specified, the default space is used.
Request bodyedit
-
closure_type -
(Optional, string) Determines whether a case is automatically closed when it is pushed to external systems. Valid values are:
-
close-by-pushing: Cases are automatically closed when they are pushed. -
close-by-user: Cases are not automatically closed.
-
-
connector -
(Optional, object) An object that contains the connector configuration.
Properties of
connector-
fields -
(Required, object) An object that contains the connector fields.
The fields specified in the case configuration are not used and are not propagated to individual cases, therefore it is recommended to set it to
null. -
id - (Required, string) The identifier for the connector. To retrieve connector IDs, use Find connectors.
-
name - (Required, string) The name of the connector.
-
type -
(Required, string) The type of the connector. Valid values are:
.cases-webhook,.jira,.none,.resilient,.servicenow,.servicenow-sir, and.swimlane.
-
-
version - (Required, string) The version of the connector. To retrieve the version value, use Get configuration.
Response codeedit
-
200 - Indicates a successful call.
Exampleedit
Change the closure type configuration option:
PATCH api/cases/configure/3297a0f0-b5ec-11ec-b141-0fdb20a7f9a9
{
"closure_type": "close-by-pushing",
"version": "WzIwMiwxXQ=="
}
The API returns the following:
{
"closure_type": "close-by-pushing",
"owner": "cases",
"created_at": "2022-06-01T17:07:17.767Z",
"created_by": {
"email": "null",
"full_name": "null",
"username": "elastic"
},
"updated_at": "2022-06-01T19:58:48.169Z",
"updated_by": {
"email": "null",
"full_name": "null",
"username": "elastic"
},
"connector": {
"id": "none",
"name": "none",
"type": ".none",
"fields": null
},
"mappings": [],
"version": "WzkwNiw1XQ==",
"error": null,
"id": "3297a0f0-b5ec-11ec-b141-0fdb20a7f9a9"
}