- 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
IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Push case API
editPush case API
editPushes a case to an external service.
Request
editPOST <kibana host>:<port>/api/cases/<case_id>/connector/<connector_id>/_push
POST <kibana host>:<port>/s/<space_id>/api/cases/<case_id>/connector/<connector_id>/_push
Prerequisites
editYou must have all
privileges for the Actions and Connectors feature in the
Management section of the
Kibana feature privileges. You must also 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 you’re pushing.
Path parameters
edit-
<case_id>
- (Required, string) The identifier for the case. To retrieve case IDs, use Find cases.
-
<connector_id>
- (Required, string) The identifier for the connector. To retrieve connector IDs, use Find connectors.
- <space_id>
- (Optional, string) An identifier for the space. If it is not specified, the default space is used.
Response codes
edit-
200
- Indicates a successful call.
Examples
editPush the case to an external service:
POST api/cases/7349772f-421a-4de3-b8bb-2d9b22ccee30/connector/abed3a70-71bd-11ea-a0b2-c51ea50a58e2/_push {}
The API returns a JSON object representing the pushed case. For example:
{ "id": "a18b38a0-71b0-11ea-a0b2-c51ea50a58e2", "version": "Wzk4LDFd", "comments": [], "totalComment": 0, "totalAlerts": 0, "title": "This case will self-destruct in 5 seconds", "tags": [ "phishing", "social engineering", "bubblegum" ], "description": "James Bond clicked on a highly suspicious email banner advertising cheap holidays for underpaid civil servants. Operation bubblegum is active. Repeat - operation bubblegum is now active!", "settings": { "syncAlerts": true }, "owner": "securitySolution", "closed_at": null, "closed_by": null, "created_at": "2022-03-29T11:30:02.658Z", "created_by": { "email": "ahunley@imf.usa.gov", "full_name": "Alan Hunley", "username": "ahunley" }, "status": "open", "updated_at": "2022-03-29T12:01:50.244Z", "updated_by": { "full_name": "Classified", "email": "classified@hms.oo.gov.uk", "username": "M" }, "connector": { "id": "08046500-bb7b-11ec-89c3-ef74ed34b2e9", "name": "My connector", "type": ".jira", "fields": { "issueType": "10006", "priority": "High", "parent": null } }, "external_service": { "pushed_at":"2022-07-26T18:19:43.688Z", "pushed_by":{ "username":"classified@hms.oo.gov.uk", "full_name":null, "email":null }, "connector_name":"My connector", "external_id":"10110", "external_title":"TPN-103", "external_url":"https://cases.jira.com", "connector_id":"08046500-bb7b-11ec-89c3-ef74ed34b2e9", } }
Was this helpful?
Thank you for your feedback.