Get case settings

Server: https://{kibana_url}

GET /api/cases/configure
GET /s/{space_id}/api/cases/configure

Refer to Spaces for more information.

Get setting details such as the closure type, custom fields, templates, and the default connector for cases. You must have read privileges for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on where the cases were created.

Query Parameters

owner union oneOf: A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all the cases that the user has access to read.; Values: cases observability securitySolution

Responses

Indicates a successful call.

application/json

Authorization information is missing or invalid.

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/cases/configure

curl Shell

curl -X GET "https://{kibana_url}/api/cases/configure"

Response

[
  {
    "closure_type": "close-by-user",
    "connector": {
      "fields": "null",
      "id": "none",
      "name": "none",
      "type": ".none"
    },
    "created_at": "2024-07-01T17:07:17.767Z",
    "created_by": {
      "email": "null",
      "full_name": "null",
      "username": "elastic"
    },
    "customFields": [
      {
        "defaultValue": "Custom text field value.",
        "key": "d312efda-ec2b-42ec-9e2c-84981795c581",
        "label": "my-text-field",
        "type": "text",
        "required": false
      }
    ],
    "error": "null",
    "extractObservables": true,
    "id": "856ee650-6c82-11ee-a20a-6164169afa58",
    "mappings": [],
    "observableTypes": [],
    "owner": "cases",
    "templates": [
      {
        "caseFields": {
          "assignees": [
            {
              "uid": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0"
            }
          ],
          "category": "Default-category",
          "connector": {
            "fields": "null",
            "id": "none",
            "name": "none",
            "type": ".none"
          },
          "customFields": [
            {
              "key": "d312efda-ec2b-42ec-9e2c-84981795c581",
              "type": "text",
              "value": "Default text field value."
            }
          ],
          "description": "A default description for cases.",
          "settings": {
            "syncAlerts": false
          },
          "tags": [
            "Default case tag"
          ],
          "title": "Default case title"
        },
        "description": "A description of the template.",
        "key": "505932fe-ee3a-4960-a661-c781b5acdb05",
        "name": "template-1",
        "tags": [
          "Template tag 1"
        ]
      }
    ],
    "updated_at": "null",
    "updated_by": "null",
    "version": "WzEyLDNd",
    "workflowTags": [
      "soc-triage"
    ]
  }
]

{
  "error": "Unauthorized",
  "message": "Unable to authenticate with the provided credentials.",
  "statusCode": 401
}