Skip to content

Commit

Permalink
update bundled APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
hop-dev committed Sep 19, 2024
1 parent 3d54e58 commit e10213b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 88 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
title: Security Solution Entity Analytics API (Elastic Cloud and self-hosted)
version: '2023-10-31'
servers:
- url: 'http://{kibana_host}:{port}'
- url: http://{kibana_host}:{port}
variables:
kibana_host:
default: localhost
Expand Down Expand Up @@ -57,8 +57,6 @@ paths:
description: Successful response
'400':
description: Invalid request
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Delete Criticality Record
tags:
- Security Solution Entity Analytics API
Expand Down Expand Up @@ -90,8 +88,6 @@ paths:
description: Invalid request
'404':
description: Criticality record not found
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Get Criticality Record
tags:
- Security Solution Entity Analytics API
Expand Down Expand Up @@ -123,8 +119,6 @@ paths:
description: Successful response
'400':
description: Invalid request
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Upsert Criticality Record
tags:
- Security Solution Entity Analytics API
Expand Down Expand Up @@ -183,14 +177,12 @@ paths:
description: Bulk upload successful
'413':
description: File too large
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Bulk Upsert Asset Criticality Records
tags:
- Security Solution Entity Analytics API
/api/asset_criticality/list:
get:
description: 'List asset criticality records, paging, sorting and filtering as needed.'
description: List asset criticality records, paging, sorting and filtering as needed.
operationId: FindAssetCriticalityRecords
parameters:
- description: The field to sort by.
Expand Down Expand Up @@ -261,8 +253,6 @@ paths:
- per_page
- total
description: Bulk upload successful
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: List Asset Criticality Records
tags:
- Security Solution Entity Analytics API
Expand All @@ -283,12 +273,10 @@ paths:
$ref: '#/components/schemas/EngineDescriptor'
type: array
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: List the Entity Engines
tags:
- Security Solution Entity Analytics API
'/api/entity_store/engines/{entityType}':
/api/entity_store/engines/{entityType}:
delete:
operationId: DeleteEntityEngine
parameters:
Expand All @@ -314,8 +302,6 @@ paths:
deleted:
type: boolean
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Delete the Entity Engine
tags:
- Security Solution Entity Analytics API
Expand All @@ -335,12 +321,10 @@ paths:
schema:
$ref: '#/components/schemas/EngineDescriptor'
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Get an Entity Engine
tags:
- Security Solution Entity Analytics API
'/api/entity_store/engines/{entityType}/init':
/api/entity_store/engines/{entityType}/init:
post:
operationId: InitEntityEngine
parameters:
Expand Down Expand Up @@ -369,12 +353,10 @@ paths:
schema:
$ref: '#/components/schemas/EngineDescriptor'
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Initialize an Entity Engine
tags:
- Security Solution Entity Analytics API
'/api/entity_store/engines/{entityType}/start':
/api/entity_store/engines/{entityType}/start:
post:
operationId: StartEntityEngine
parameters:
Expand All @@ -394,12 +376,10 @@ paths:
started:
type: boolean
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Start an Entity Engine
tags:
- Security Solution Entity Analytics API
'/api/entity_store/engines/{entityType}/stats':
/api/entity_store/engines/{entityType}/stats:
post:
operationId: GetEntityEngineStats
parameters:
Expand Down Expand Up @@ -431,12 +411,10 @@ paths:
type:
$ref: '#/components/schemas/EntityType'
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Get Entity Engine stats
tags:
- Security Solution Entity Analytics API
'/api/entity_store/engines/{entityType}/stop':
/api/entity_store/engines/{entityType}/stop:
post:
operationId: StopEntityEngine
parameters:
Expand All @@ -456,14 +434,12 @@ paths:
stopped:
type: boolean
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Stop an Entity Engine
tags:
- Security Solution Entity Analytics API
/api/entity_store/entities/list:
get:
description: 'List entities records, paging, sorting and filtering as needed.'
description: List entities records, paging, sorting and filtering as needed.
operationId: ListEntities
parameters:
- in: query
Expand Down Expand Up @@ -534,8 +510,6 @@ paths:
- per_page
- total
description: Entities returned successfully
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: List Entity Store Entities
tags:
- Security Solution Entity Analytics API
Expand Down Expand Up @@ -564,19 +538,10 @@ paths:
schema:
$ref: '#/components/schemas/RiskEngineScheduleNowErrorResponse'
description: Unexpected error
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Schedule the risk engine to run as soon as possible
tags:
- Security Solution Entity Analytics API
components:
callbacks: !<tag:yaml.org,2002:js/undefined> ''
examples: !<tag:yaml.org,2002:js/undefined> ''
headers: !<tag:yaml.org,2002:js/undefined> ''
links: !<tag:yaml.org,2002:js/undefined> ''
parameters: !<tag:yaml.org,2002:js/undefined> ''
requestBodies: !<tag:yaml.org,2002:js/undefined> ''
responses: !<tag:yaml.org,2002:js/undefined> ''
schemas:
AssetCriticalityBulkUploadErrorItem:
type: object
Expand Down Expand Up @@ -872,4 +837,3 @@ security:
tags:
- description: ''
name: Security Solution Entity Analytics API
externalDocs: !<tag:yaml.org,2002:js/undefined> ''
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
title: Security Solution Entity Analytics API (Elastic Cloud Serverless)
version: '2023-10-31'
servers:
- url: 'http://{kibana_host}:{port}'
- url: http://{kibana_host}:{port}
variables:
kibana_host:
default: localhost
Expand Down Expand Up @@ -57,8 +57,6 @@ paths:
description: Successful response
'400':
description: Invalid request
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Delete Criticality Record
tags:
- Security Solution Entity Analytics API
Expand Down Expand Up @@ -90,8 +88,6 @@ paths:
description: Invalid request
'404':
description: Criticality record not found
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Get Criticality Record
tags:
- Security Solution Entity Analytics API
Expand Down Expand Up @@ -123,8 +119,6 @@ paths:
description: Successful response
'400':
description: Invalid request
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Upsert Criticality Record
tags:
- Security Solution Entity Analytics API
Expand Down Expand Up @@ -183,14 +177,12 @@ paths:
description: Bulk upload successful
'413':
description: File too large
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Bulk Upsert Asset Criticality Records
tags:
- Security Solution Entity Analytics API
/api/asset_criticality/list:
get:
description: 'List asset criticality records, paging, sorting and filtering as needed.'
description: List asset criticality records, paging, sorting and filtering as needed.
operationId: FindAssetCriticalityRecords
parameters:
- description: The field to sort by.
Expand Down Expand Up @@ -261,8 +253,6 @@ paths:
- per_page
- total
description: Bulk upload successful
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: List Asset Criticality Records
tags:
- Security Solution Entity Analytics API
Expand All @@ -283,12 +273,10 @@ paths:
$ref: '#/components/schemas/EngineDescriptor'
type: array
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: List the Entity Engines
tags:
- Security Solution Entity Analytics API
'/api/entity_store/engines/{entityType}':
/api/entity_store/engines/{entityType}:
delete:
operationId: DeleteEntityEngine
parameters:
Expand All @@ -314,8 +302,6 @@ paths:
deleted:
type: boolean
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Delete the Entity Engine
tags:
- Security Solution Entity Analytics API
Expand All @@ -335,12 +321,10 @@ paths:
schema:
$ref: '#/components/schemas/EngineDescriptor'
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Get an Entity Engine
tags:
- Security Solution Entity Analytics API
'/api/entity_store/engines/{entityType}/init':
/api/entity_store/engines/{entityType}/init:
post:
operationId: InitEntityEngine
parameters:
Expand Down Expand Up @@ -369,12 +353,10 @@ paths:
schema:
$ref: '#/components/schemas/EngineDescriptor'
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Initialize an Entity Engine
tags:
- Security Solution Entity Analytics API
'/api/entity_store/engines/{entityType}/start':
/api/entity_store/engines/{entityType}/start:
post:
operationId: StartEntityEngine
parameters:
Expand All @@ -394,12 +376,10 @@ paths:
started:
type: boolean
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Start an Entity Engine
tags:
- Security Solution Entity Analytics API
'/api/entity_store/engines/{entityType}/stats':
/api/entity_store/engines/{entityType}/stats:
post:
operationId: GetEntityEngineStats
parameters:
Expand Down Expand Up @@ -431,12 +411,10 @@ paths:
type:
$ref: '#/components/schemas/EntityType'
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Get Entity Engine stats
tags:
- Security Solution Entity Analytics API
'/api/entity_store/engines/{entityType}/stop':
/api/entity_store/engines/{entityType}/stop:
post:
operationId: StopEntityEngine
parameters:
Expand All @@ -456,14 +434,12 @@ paths:
stopped:
type: boolean
description: Successful response
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Stop an Entity Engine
tags:
- Security Solution Entity Analytics API
/api/entity_store/entities/list:
get:
description: 'List entities records, paging, sorting and filtering as needed.'
description: List entities records, paging, sorting and filtering as needed.
operationId: ListEntities
parameters:
- in: query
Expand Down Expand Up @@ -534,8 +510,6 @@ paths:
- per_page
- total
description: Entities returned successfully
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: List Entity Store Entities
tags:
- Security Solution Entity Analytics API
Expand Down Expand Up @@ -564,19 +538,10 @@ paths:
schema:
$ref: '#/components/schemas/RiskEngineScheduleNowErrorResponse'
description: Unexpected error
servers: !<tag:yaml.org,2002:js/undefined> ''
security: !<tag:yaml.org,2002:js/undefined> ''
summary: Schedule the risk engine to run as soon as possible
tags:
- Security Solution Entity Analytics API
components:
callbacks: !<tag:yaml.org,2002:js/undefined> ''
examples: !<tag:yaml.org,2002:js/undefined> ''
headers: !<tag:yaml.org,2002:js/undefined> ''
links: !<tag:yaml.org,2002:js/undefined> ''
parameters: !<tag:yaml.org,2002:js/undefined> ''
requestBodies: !<tag:yaml.org,2002:js/undefined> ''
responses: !<tag:yaml.org,2002:js/undefined> ''
schemas:
AssetCriticalityBulkUploadErrorItem:
type: object
Expand Down Expand Up @@ -872,4 +837,3 @@ security:
tags:
- description: ''
name: Security Solution Entity Analytics API
externalDocs: !<tag:yaml.org,2002:js/undefined> ''

0 comments on commit e10213b

Please sign in to comment.