-
Notifications
You must be signed in to change notification settings - Fork 191
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add API docs back to staging repo [Serverless] (#82)
* Revert "Remove API docs files from staging repo (temporarily) [Serverless] (#65)" This reverts commit e4f4c7b. * Move transclusions folder * Move endpoint apis * Move cases APIs * Move the rest of the APIs Detections, Exceptions, Lists * Fix image ref * Reorg * Add pages to docnav * Map new pages to classic-sources sandbox ids * Add rough content banner to all API pages * Comment out descriptions (for now) * Add basic tags
- Loading branch information
1 parent
53d94d3
commit 2d396e0
Showing
83 changed files
with
14,726 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
id: serverlessSecurityActionsApiOverview | ||
slug: /serverless/security/actions-api-overview | ||
title: Actions API (for pushing cases to external systems) | ||
# description: Description to be written | ||
tags: [ 'serverless', 'security', 'reference' ] | ||
status: rough content | ||
--- | ||
|
||
import RoughContent from '../../partials/rough-content-notice.mdx' | ||
|
||
<RoughContent /> | ||
|
||
|
||
<div id="actions-api-overview"></div> | ||
|
||
You can push ((elastic-sec)) cases to these third-party systems: | ||
|
||
* ((sn)) | ||
* ((jira)) (including Jira Service Desk) | ||
* ((ibm-r)) | ||
* ((swimlane)) | ||
* ((webhook-cm)) | ||
|
||
To push cases, you need to create a connector, which stores the information | ||
required to communicate with the external system. | ||
|
||
((elastic-sec)) uses these external APIs to send cases: | ||
|
||
* ((sn)): [Import Set API](https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/c_ImportSetAPI) | ||
* ((jira)): [REST API v2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) | ||
* ((ibm-r)): [Resilient REST API](https://developer.ibm.com/security/resilient/rest/) | ||
* ((swimlane)): [Swimlane REST API](https://swimlane.com/knowledge-center/docs/developer-guide/rest-api/) | ||
|
||
To send cases to an external system and keep the ((elastic-sec)) UI updated: | ||
|
||
1. [Create connector](((kibana-ref))/create-connector-api.html): Create the connector. | ||
1. [Create case](((kibana-ref))/cases-api-create.html): Create a case with the connector from the previous step. | ||
1. [Push case](((kibana-ref))/cases-api-push.html): Push the case to the external system. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
id: serverlessSecurityCasesApiOverview | ||
slug: /serverless/security/cases-api-overview | ||
title: Cases API | ||
# description: Description to be written | ||
tags: [ 'serverless', 'security', 'reference' ] | ||
status: rough content | ||
--- | ||
|
||
import RoughContent from '../../partials/rough-content-notice.mdx' | ||
|
||
<RoughContent /> | ||
|
||
<div id="cases-api-overview"></div> | ||
|
||
You can create, manage, configure, and send cases to external systems with these APIs: | ||
|
||
<DocCallOut title="Note"> | ||
Cases return a warning header for deprecated endpoints. The value of the warning header is in the form `299 Kibana-((kibana_version)) "{warning_text}"` | ||
</DocCallOut> | ||
|
||
* [Cases APIs](((kibana-ref))/cases-api.html): Used to open and manage security action items. | ||
|
||
* [Connector APIs](((kibana-ref))/actions-and-connectors-api.html): Used to communicate with and send cases to external systems. | ||
|
Oops, something went wrong.