IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Set default Elastic Security UI connector Get current connector »

› › ›

Update case configurations

edit

Update case configurations

edit

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 URL

edit

PATCH <kibana host>:<port>/api/cases/configure

Request body

edit

A JSON object with these fields:

Name	Type	Description	Required
`connector`	connector	Object containing the connector’s configuration.	Yes
`closure_type`	String	Determines whether a case is automatically closed in Elastic Security when it is pushed to external systems. Valid values are: `close-by-pushing`: Elastic Security cases are automatically closed when they are pushed. `close-by-user`: Elastic Security cases are not automatically closed.	No
`version`	String	The connector version.	Yes

connector schema

Name	Type	Description	Required
`id`	String	The ID of the connector you want to use for sending cases to external systems.	Yes
`name`	String	The connector name.	Yes
`type`	String	The type of the connector. Must be one of these: `.servicenow` `.jira` `.resilient` `.none`	Yes
`fields`	Object	Object containing connector’s fields. For ServiceNow connectors: `urgency` (string \| null): The urgency of the incident. `severity` (string \| null): The severity of the incident. `impact` (string \| null): The impact of the incident. For Jira connectors: `issueType` (string): The issue type of the issue. `priority` (string \| null): The priority of the issue. `parent` (string \| null): The key of the parent issue (Valid when the issue type is `Sub-task`). For IBM Resilient connectors: `issueTypes` (number[]): The issue types of the issue. `severityCode` (number): The severity code of the issue.	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

edit

Changes the connector’s case closure option:

PATCH api/cases/configure
{
  "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"
  },
  "updated_at": "2020-03-31T06:21:35.759Z",
  "updated_by": {
    "email": "admin@hms.gov.uk",
    "full_name": "Ms Admin",
    "username": "admin"
  },
  "version": "WzIwMywxXQ=="
}

« Set default Elastic Security UI connector Get current connector »