- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.2
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Enterprise Search settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Monitoring settings
- Reporting settings
- Search sessions settings
- Secure settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- URL drilldown settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Configure security
- Configure reporting
- Configure logging
- Configure monitoring
- Command line tools
- Production considerations
- Discover
- Dashboard and visualizations
- Canvas
- Maps
- Build a map to compare metrics by country or region
- Track, visualize, and alert on assets in real time
- Map custom regions with reverse geocoding
- Heat map layer
- Tile layer
- Vector layer
- Plot big data
- Search geographic data
- Configure map settings
- Connect to Elastic Maps Service
- Import geospatial data
- Troubleshoot
- Reporting and sharing
- Machine learning
- Graph
- Alerting
- Observability
- APM
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- REST API
- Get features API
- Kibana spaces APIs
- Kibana role management APIs
- User session management APIs
- Saved objects APIs
- Data views API
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- Import and export dashboard APIs
- Logstash configuration management APIs
- Machine learning APIs
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Developer guide
Set case configuration API
editSet case configuration API
editSets external connection details, such as the closure type and default connector for cases.
Request
editPOST <kibana host>:<port>/api/cases/configure
POST <kibana host>:<port>/s/<space_id>/api/cases/configure
Prerequisites
editYou 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.
Description
editConnectors are used to interface with external systems. You must create a connector before you can use it in your cases. Refer to Add connectors.
If you set a default connector, it is automatically selected when you create cases in Kibana. If you use the create case API, however, you must still specify all of the connector details.
Path parameters
edit-
<space_id>
- (Optional, string) An identifier for the space. If it is not specified, the default space is used.
Request body
edit-
closure_type
-
(Required, string) Specifies 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
-
(Required, 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. If you do not want a
default connector, use
none
. To retrieve connector IDs, use Find connectors. -
name
-
(Required, string) The name of the connector. If you do not want a default
connector, use
none
. To retrieve connector names, use Find connectors. -
type
-
(Required, string) The type of the connector. Valid values are:
.jira
,.none
,.resilient
,.servicenow
,.servicenow-sir
, and.swimlane
.
-
-
owner
-
(Required, string) The application that owns the case configuration. Valid
values are:
cases
,observability
, orsecuritySolution
. This value affects whether you’re setting case configuration details for Stack Management, Observability, or Elastic Security app. -
settings
-
(Optional, object) An object that contains the case settings.
Properties of
settings
-
syncAlerts
- (Required, boolean) Turns alert syncing on or off.
-
Response codes
edit-
200
- Indicates a successful call.
Examples
editSets the closure type and default connector for cases in Stack Management:
POST api/cases/configure { "owner": "cases", "connector": { "id": "131d4448-abe0-4789-939d-8ef60680b498", "name": "my-serviceNow", "type": ".servicenow", "fields": null, }, "closure_type": "close-by-user" }
The API returns the following response:
{ "owner": "cases", "closure_type": "close-by-user", "created_at": "2022-04-02T01:09:02.303Z", "created_by": { "email": "moneypenny@hms.gov.uk", "full_name": "Ms Moneypenny", "username": "moneypenny" }, "updated_at": null, "updated_by": null, "connector": { "id": "131d4448-abe0-4789-939d-8ef60680b498", "name": "my-serviceNow", "type": ".servicenow", "fields": null, }, "mappings": [ { "source": "title", "target": "short_description", "action_type": "overwrite" }, { "source":"description", "target":"description", "action_type":"overwrite" }, { "source":"comments", "target":"work_notes", "action_type":"append" } ], "version": "WzE3NywxXQ==", "error": null, "id": "7349772f-421a-4de3-b8bb-2d9b22ccee30", }