Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kibana Security Endpoint Management API API

Interact with and manage endpoints running the Elastic Defend integration.

Kibana Security Endpoint Management API API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Security Endpoint Management API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 23 operations across 22 paths, and defines 67 schemas. It is described by OpenAPI 3.0.3.

Requests are made against a single base URL, https://{kibana_url}.

23 operations 22 paths 67 schemas 10 GET13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
Base URL
https://localhost:5601/api
Authentication
API Key, HTTP Basic
Contact
Kibana Team
Resource Areas
1

Authentication & Security 2

Kibana Security Endpoint Management API API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • apiKeyAuth — These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64A…

Paths & Operations 23

Across 22 paths, the API surfaces 23 operations — 10 GET, 13 POST. Each is listed below with its method, path, parameters, and response codes.

Security Endpoint Management API 23

Interact with and manage endpoints running the Elastic Defend integration.

GET
/api/endpoint/action
Get response actions
EndpointGetActionsList 10 params → 200
GET
/api/endpoint/action_status
Get response actions status
EndpointGetActionsStatus 1 param → 200
GET
/api/endpoint/action/{action_id}
Get action details
EndpointGetActionsDetails 1 param → 200
GET
/api/endpoint/action/{action_id}/file/{file_id}
Get file information
EndpointFileInfo 2 params → 200
GET
/api/endpoint/action/{action_id}/file/{file_id}/download
Download a file
EndpointFileDownload 2 params → 200
POST
/api/endpoint/action/cancel
Cancel a response action
CancelAction body → 200
POST
/api/endpoint/action/execute
Run a command
EndpointExecuteAction body → 200
POST
/api/endpoint/action/get_file
Get a file
EndpointGetFileAction body → 200
POST
/api/endpoint/action/isolate
Isolate an endpoint
EndpointIsolateAction body → 200
POST
/api/endpoint/action/kill_process
Terminate a process
EndpointKillProcessAction body → 200
POST
/api/endpoint/action/memory_dump
Generate a memory dump from the host machine
EndpointGenerateMemoryDump body → 200
POST
/api/endpoint/action/running_procs
Get running processes
EndpointGetProcessesAction body → 200
POST
/api/endpoint/action/runscript
Run a script
RunScriptAction body → 200
POST
/api/endpoint/action/scan
Scan a file or directory
EndpointScanAction body → 200
GET
/api/endpoint/action/state
Get actions state
EndpointGetActionsState → 200
POST
/api/endpoint/action/suspend_process
Suspend a process
EndpointSuspendProcessAction body → 200
POST
/api/endpoint/action/unisolate
Release an isolated endpoint
EndpointUnisolateAction body → 200
POST
/api/endpoint/action/upload
Upload a file
EndpointUploadAction body → 200
GET
/api/endpoint/metadata
Get a metadata list
GetEndpointMetadataList 6 params → 200
GET
/api/endpoint/metadata/{id}
Get metadata
GetEndpointMetadata 1 param → 200
GET
/api/endpoint/policy_response
Get a policy response
GetPolicyResponse 1 param → 200
GET
/api/endpoint/protection_updates_note/{package_policy_id}
Get a protection updates note
GetProtectionUpdatesNote 1 param → 200
POST
/api/endpoint/protection_updates_note/{package_policy_id}
Create or update a protection updates note
CreateUpdateProtectionUpdatesNote 1 param body → 200

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are Security_Endpoint_Management_API_ResponseActionDetails (15 properties), Security_Endpoint_Management_API_GetEndpointActionListResponse (11 properties), Security_Endpoint_Management_API_GetProcessesRouteRequestBody (6 properties), Security_Endpoint_Management_API_RunscriptParamsCrowdStrike (5 properties). Each schema is shown below with its type and property counts.

Security_Endpoint_Management_API_RunscriptParamsCrowdStrike
object
5 properties
Security_Endpoint_Management_API_ActionDetailsResponse
Security_Endpoint_Management_API_Isolate
Security_Endpoint_Management_API_SuccessResponse
object
A generic successful response.
Security_Endpoint_Management_API_Comment
string
Optional comment
Security_Endpoint_Management_API_PendingActionsSchema
Security_Endpoint_Management_API_SortField
string
Determines which field is used to sort the results.
Security_Endpoint_Management_API_HostStatuses
array
A set of agent health statuses to filter by.
Security_Endpoint_Management_API_EndDate
string
An end date in ISO format or Date Math format.
Security_Endpoint_Management_API_RunscriptParamsSentinelOne
object
2 properties
Security_Endpoint_Management_API_ResponseActionCreateSuccessResponse
object
1 property
Security_Endpoint_Management_API_Runscript
Security_Endpoint_Management_API_Scan
Security_Endpoint_Management_API_Page
integer
Page number
Security_Endpoint_Management_API_UnisolateRouteResponse
object
2 properties
Security_Endpoint_Management_API_SuspendProcess
Security_Endpoint_Management_API_CancelRouteRequestBody
Security_Endpoint_Management_API_Cancel
Security_Endpoint_Management_API_AgentTypes
string
List of agent types to retrieve. Defaults to endpoint.
Security_Endpoint_Management_API_IsolateRouteResponse
object
2 properties
Security_Endpoint_Management_API_SuspendProcessRouteRequestBody
Security_Endpoint_Management_API_StartDate
string
A start date in ISO 8601 format or Date Math format.
Security_Endpoint_Management_API_DownloadUri
object
1 property
Security_Endpoint_Management_API_WithOutputs
A list of action IDs that should include the complete output of the action. Max of 50.
Security_Endpoint_Management_API_AgentIds
A list of agent IDs. Max of 250.
Security_Endpoint_Management_API_RunningProcesses
Security_Endpoint_Management_API_Command
string
The command for the response action
Security_Endpoint_Management_API_UserIds
A list of user IDs. Max of 50.
Security_Endpoint_Management_API_SortDirection
string
Determines the sort order.
Security_Endpoint_Management_API_EndpointIds
array
List of endpoint IDs (cannot contain empty strings). Max of 250.
Security_Endpoint_Management_API_Kuery
string
A KQL string.
Security_Endpoint_Management_API_KillProcess
Security_Endpoint_Management_API_AgentId
string
Agent ID
Security_Endpoint_Management_API_PageSize
integer
Number of items per page
Security_Endpoint_Management_API_SentinelOneRunScriptParameters
object
Parameters for Run Script response action against SentinelOne agent type.
2 properties 1 required
Security_Endpoint_Management_API_GetEndpointActionListResponse
object
11 properties
Security_Endpoint_Management_API_UploadRouteRequestBody
Security_Endpoint_Management_API_Commands
array
A list of response action command names.
Security_Endpoint_Management_API_KillProcessRouteRequestBody
Security_Endpoint_Management_API_EndpointMetadataResponse
object
Security_Endpoint_Management_API_Type
string
Type of response action
Security_Endpoint_Management_API_MemoryDumpRouteRequestBody
Security_Endpoint_Management_API_ResponseActionDetails
object
15 properties 1 required
Security_Endpoint_Management_API_MDERunScriptParameters
object
Parameters for Run Script response action against Microsoft Defender Endpoint agent type.
2 properties 1 required
Security_Endpoint_Management_API_ExecuteRouteRequestBody
Security_Endpoint_Management_API_Types
array
List of types of response actions
Security_Endpoint_Management_API_MemoryDump
Security_Endpoint_Management_API_Upload
Security_Endpoint_Management_API_Execute
Security_Endpoint_Management_API_Unisolate
Security_Endpoint_Management_API_RunningProcessesOutputSentinelOne
Security_Endpoint_Management_API_GetProcessesRouteRequestBody
object
6 properties 1 required
Security_Endpoint_Management_API_ActionStateSuccessResponse
object
1 property 1 required
Security_Endpoint_Management_API_ScanRouteRequestBody
Security_Endpoint_Management_API_RunningProcessesOutputEndpoint
object
Processes output for agentType of endpoint
2 properties
Security_Endpoint_Management_API_HostPathScriptParameters
object
3 properties 1 required
Security_Endpoint_Management_API_GetFile
Security_Endpoint_Management_API_RunscriptParamsMicrosoft
object
2 properties
Security_Endpoint_Management_API_ProtectionUpdatesNoteResponse
object
1 property
Security_Endpoint_Management_API_ActionStatusSuccessResponse
object
1 property 1 required
Security_Endpoint_Management_API_RawScriptParameters
object
3 properties 1 required
Security_Endpoint_Management_API_RunScriptRouteRequestBody
Security_Endpoint_Management_API_CloudFileScriptParameters
object
3 properties 1 required
Security_Endpoint_Management_API_PendingActionDataType
integer
Number of pending actions of this type.
Security_Endpoint_Management_API_GetFileRouteRequestBody
Security_Endpoint_Management_API_Parameters
object
Parameters object
Security_Endpoint_Management_API_MetadataListResponse
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kibana-security-endpoint-management-api-api-openapi.yml Raw ↑

Other APIs Kibana publishes across the network.

Kibana Actions API
Kibana agent builder API
Kibana alerting API
Kibana APM agent configuration API
Kibana APM agent keys API
Kibana APM annotations API
Kibana APM server schema API
Kibana APM sourcemaps API
Kibana cases API
Kibana connectors API
Kibana Data streams API
Kibana data views API