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

› › ›

Get case configuration API

edit

Get case configuration API

edit

Retrieves external connection details, such as the closure type and default connector for cases.

Request

edit

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

GET <kibana host>:<port>/s/<space_id>/api/cases/configure

Prerequisites

edit

You must have read 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.

Path parameters

edit

<space_id>: (Optional, string) An identifier for the space. If it is not specified, the default space is used.

Query parameters

edit

owner: (Optional, string or array of strings) A filter to limit the retrieved details to a specific set of applications. Valid values are: cases, observability, and securitySolution. If this parameter is omitted, the response contains information for all applications that the user has access to read.

Response code

edit

200: Indicates a successful call.

Example

edit

GET api/cases/configure?owner=securitySolution

The API returns the following type of information:

[
  {
    "owner": "securitySolution",
    "closure_type": "close-by-user",
    "created_at": "2020-03-30T13:31:38.083Z",
    "created_by": {
      "email": "admin@hms.gov.uk",
      "full_name": "Mr Admin",
      "username": "admin"
    },
    "updated_at": null,
    "updated_by": null,
    "connector": {
      "id": "131d4448-abe0-4789-939d-8ef60680b498",
      "name": "my-jira",
      "type": ".jira",
      "fields": null
    },
    "mappings": [
      {
        "source": "title",
        "target": "summary",
        "action_type": "overwrite"
      },
      {
        "source": "description",
        "target": "description",
        "action_type": "overwrite"
      },
      {
        "source": "comments",
        "target": "comments",
        "action_type": "append"
      }
    ],
    "version": "WzE3NywxXQ==",
    "error": null,
    "id": "7349772f-421a-4de3-b8bb-2d9b22ccee30"
  }
]

« Get comments API Get reporters API »