Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
183 changes: 183 additions & 0 deletions oas_docs/output/kibana.serverless.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16197,6 +16197,47 @@ paths:
x-metaTags:
- content: Kibana, Elastic Cloud Serverless
name: product_name
/api/endpoint/action/memory_dump:
post:
description: |-
**Spaces method and path for this operation:**

<div><span class="operation-verb post">post</span>&nbsp;<span class="operation-path">/s/{space_id}/api/endpoint/action/memory_dump</span></div>

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Generates memory dumps on the targeted host.
operationId: EndpointGenerateMemoryDump
requestBody:
content:
application/json:
examples:
ProcessMemoryDump:
summary: Generate a memory dump from the host machine
value:
agent_type: endpoint
comment: Generating memory dump for investigation
endpoint_ids:
- ed518850-681a-4d60-bb98-e22640cae2a8
parameters:
entity_id: abc123
type: process
schema:
$ref: '#/components/schemas/Security_Endpoint_Management_API_MemoryDumpRouteRequestBody'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Security_Endpoint_Management_API_ResponseActionCreateSuccessResponse'
description: Action request was successfully created
summary: Generate a memory dump from the host machine
tags:
- Security Endpoint Management API
x-metaTags:
- content: Kibana, Elastic Cloud Serverless
name: product_name
/api/endpoint/action/running_procs:
post:
description: |-
Expand Down Expand Up @@ -90311,6 +90352,7 @@ components:
get-file: '#/components/schemas/Security_Endpoint_Management_API_GetFile'
isolate: '#/components/schemas/Security_Endpoint_Management_API_ResponseActionDetails'
kill-process: '#/components/schemas/Security_Endpoint_Management_API_KillProcess'
memory-dump: '#/components/schemas/Security_Endpoint_Management_API_MemoryDump'
running-processes: '#/components/schemas/Security_Endpoint_Management_API_RunningProcesses'
runscript: '#/components/schemas/Security_Endpoint_Management_API_Runscript'
scan: '#/components/schemas/Security_Endpoint_Management_API_Scan'
Expand All @@ -90330,6 +90372,7 @@ components:
- $ref: '#/components/schemas/Security_Endpoint_Management_API_ResponseActionDetails'
- $ref: '#/components/schemas/Security_Endpoint_Management_API_SuspendProcess'
- $ref: '#/components/schemas/Security_Endpoint_Management_API_RunningProcesses'
- $ref: '#/components/schemas/Security_Endpoint_Management_API_MemoryDump'
Security_Endpoint_Management_API_ActionStateSuccessResponse:
type: object
properties:
Expand Down Expand Up @@ -91273,6 +91316,146 @@ components:
- scriptName
title: Microsoft Defender Endpoint Run Script Parameters
type: object
Security_Endpoint_Management_API_MemoryDump:
allOf:
- $ref: '#/components/schemas/Security_Endpoint_Management_API_ResponseActionDetails'
- type: object
properties:
outputs:
additionalProperties:
type: object
properties:
content:
properties:
code:
type: string
disk_free_space:
description: The free space on the host machine in bytes after the memory dump is written to disk
type: number
file_size:
description: The size of the memory dump compressed file in bytes
type: string
path:
description: The path to the memory dump compressed file on the host machine
type: string
title: Memory dump output
type: object
type: object
parameters:
oneOf:
- properties:
type:
description: Kernel level memory dump
enum:
- kernel
type: string
required:
- type
title: Kernel memory dump
type: object
- properties:
pid:
description: The process ID (PID)
type: number
type:
description: Process level memory dump using a process ID
enum:
- process
type: string
required:
- type
- pid
title: Process memory dump with PID
type: object
- properties:
entity_id:
description: The process entity ID
type: string
type:
description: Process level memory dump using an entity ID
enum:
- process
type: string
required:
- type
- entity_id
title: Process memory dump with entity ID
type: object
required:
- parameters
Security_Endpoint_Management_API_MemoryDumpRouteRequestBody:
allOf:
- type: object
properties:
agent_type:
$ref: '#/components/schemas/Security_Endpoint_Management_API_AgentTypes'
alert_ids:
description: If this action is associated with any alerts, they can be specified here. The action will be logged in any cases associated with the specified alerts.
example:
- alert-id-1
- alert-id-2
items:
minLength: 1
type: string
minItems: 1
type: array
case_ids:
description: The IDs of cases where the action taken will be logged.
example:
- case-id-1
- case-id-2
items:
minLength: 1
type: string
minItems: 1
type: array
comment:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
endpoint_ids:
$ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
parameters:
$ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
required:
- endpoint_ids
- type: object
properties:
parameters:
oneOf:
- description: Dump the entire kernel memory.
type: object
properties:
type:
enum:
- kernel
type: string
required:
- type
- description: Dump the entire memory of a process using the PID.
type: object
properties:
pid:
type: number
type:
enum:
- process
type: string
required:
- type
- pid
- description: Dump the entire memory of a process using the entity ID.
type: object
properties:
entity_id:
type: string
type:
enum:
- process
type: string
required:
- type
- entity_id
required:
- parameters
Security_Endpoint_Management_API_MetadataListResponse:
example:
data:
Expand Down
Loading