Skip to content

Commit 79895c0

Browse files
squiocgithub-actions[bot]
authored andcommitted
Refresh automation library documentation
1 parent 433fd63 commit 79895c0

2 files changed

Lines changed: 65 additions & 66 deletions

File tree

_shared_content/automate/library/sekoia-io.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1012,8 +1012,8 @@ Retrieve the definition of an alert
10121012

10131013
| Name | Type | Description |
10141014
| --------- | ------- | --------------------------- |
1015-
| `uuid` | `string` | |
1016-
| `stix` | `boolean` | |
1015+
| `uuid` | `string` | UUID of the alert to retrieve. |
1016+
| `stix` | `boolean` | If true, include the full STIX 2 bundle in the response (default: false). |
10171017
| `cases` | `boolean` | Fetch the cases associated with this alert in addition (default: false) |
10181018

10191019

@@ -1022,42 +1022,42 @@ Retrieve the definition of an alert
10221022
| Name | Type | Description |
10231023
| --------- | ------- | --------------------------- |
10241024
| `urgency` | `object` | |
1025-
| `history` | `array` | |
1025+
| `history` | `array` | Ordered list of modifications made to the alert (status changes, field updates, assignments, etc.). |
10261026
| `is_incident` | `boolean` | |
1027-
| `assets` | `array` | |
1028-
| `countermeasures` | `array` | |
1029-
| `updated_at` | `integer` | |
1030-
| `comments` | `array` | |
1031-
| `ttps` | `array` | |
1032-
| `number_of_unseen_comments` | `integer` | |
1033-
| `status` | `object` | |
1027+
| `assets` | `array` | UUIDs of the assets involved in the alert. |
1028+
| `countermeasures` | `array` | Response actions (countermeasures) recommended or applied in reaction to the alert. Each countermeasure has a name, a description, a list of concrete action steps to execute, and a lifecycle status (pending → activated or denied). They can originate from three sources, reflected in the `type` field: `text` (free-form analyst note, e.g. 'Isolate the affected host'), `intelligence_center` (a course of action sourced from SEKOIA.IO's threat intelligence, e.g. 'Block IOC X on your firewall'), or `openc2` (a machine-readable OpenC2 command sent to a security actuator). Included by default; opt out with `?countermeasures=false`. |
1029+
| `updated_at` | `integer` | Unix timestamp (whole seconds) of the last update to the alert. |
1030+
| `comments` | `array` | Comments left by analysts on the alert. Each entry carries an `unseen` flag for the current user. |
1031+
| `ttps` | `array` | MITRE ATT&CK techniques, tactics and procedures (TTPs) associated with the alert, as minimal STIX objects. |
1032+
| `number_of_unseen_comments` | `integer` | Number of comments on the alert not yet seen by the current user. |
1033+
| `status` | `object` | Current workflow status of the alert (e.g. `Pending`, `Acknowledged`, `Ongoing`, `Closed`). |
10341034
| `custom_status_uuid` | `string` | UUID of the custom status associated to the alert |
10351035
| `custom_status` | `object` | |
10361036
| `verdict` | `object` | |
1037-
| `created_by` | `string` | |
1038-
| `updated_by` | `string` | |
1039-
| `source` | `string` | |
1040-
| `community_uuid` | `string` | |
1041-
| `number_of_total_comments` | `integer` | |
1042-
| `uuid` | `string` | |
1043-
| `rule` | `object` | |
1044-
| `adversaries` | `array` | |
1045-
| `short_id` | `string` | |
1046-
| `first_seen_at` | `string` | |
1047-
| `last_seen_at` | `string` | |
1037+
| `created_by` | `string` | UUID of the profile that created the alert. |
1038+
| `updated_by` | `string` | UUID of the profile that last updated the alert. |
1039+
| `source` | `string` | Source of the suspicious activity (e.g. an IP address or hostname). |
1040+
| `community_uuid` | `string` | UUID of the community the alert belongs to. |
1041+
| `number_of_total_comments` | `integer` | Total number of comments on the alert. |
1042+
| `uuid` | `string` | Unique identifier of the alert. |
1043+
| `rule` | `object` | Detection rule that triggered the alert. |
1044+
| `adversaries` | `array` | Threat actors or adversary groups attributed to the alert, as minimal STIX Domain Objects (for example, `threat-actor`). |
1045+
| `short_id` | `string` | Human-readable short identifier for the alert (e.g. `ALa1b2c3d4e5`). |
1046+
| `first_seen_at` | `string` | Timestamp of the first event that contributed to this alert. |
1047+
| `last_seen_at` | `string` | Timestamp of the most recent event that contributed to this alert. |
10481048
| `event_uuids` | `array` | |
1049-
| `kill_chain_short_id` | `string` | |
1050-
| `similar` | `integer` | |
1051-
| `alert_type` | `object` | |
1052-
| `details` | `string` | |
1053-
| `stix` | `object` | |
1054-
| `created_by_type` | `string` | |
1055-
| `entity` | `object` | |
1056-
| `created_at` | `integer` | |
1057-
| `updated_by_type` | `string` | |
1058-
| `title` | `string` | |
1059-
| `target` | `string` | |
1060-
| `cases` | `array` | |
1049+
| `kill_chain_short_id` | `string` | Short identifier of the MITRE ATT&CK tactic associated with the alert (e.g. `TA0001` for Initial Access). |
1050+
| `similar` | `integer` | Number of similar alerts detected by the platform's deduplication mechanism. |
1051+
| `alert_type` | `object` | Category and value describing the type of threat (e.g. category `malware`, value `ransomware`). |
1052+
| `details` | `string` | Free-text field providing additional analyst context or notes about the alert. |
1053+
| `stix` | `object` | Full STIX 2 bundle describing the alert and its related objects. Only populated when `?stix=true` is passed. |
1054+
| `created_by_type` | `string` | Type of the profile that created the alert (e.g. `application`, `avatar`). |
1055+
| `entity` | `object` | Entity (asset group) targeted by the alert. |
1056+
| `created_at` | `integer` | Unix timestamp in whole seconds when the alert was created. |
1057+
| `updated_by_type` | `string` | Type of the profile that last updated the alert (e.g. `application`, `avatar`). |
1058+
| `title` | `string` | Human-readable title of the alert. |
1059+
| `target` | `string` | Target of the suspicious activity (e.g. an IP address or hostname). |
1060+
| `cases` | `array` | Cases this alert has been grouped into. Only populated when `?cases=true` is passed. |
10611061

10621062
### [DEPRECATED] Get Asset (V2)
10631063

@@ -2204,4 +2204,4 @@ Update a rule
22042204

22052205
## Extra
22062206

2207-
Module **`Sekoia.io` v2.71.0**
2207+
Module **`Sekoia.io` v2.71.5**

mkdocs.yml

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ nav:
4040
- Getting started:
4141
- Overview: getting_started/index.md
4242
- Where to start: getting_started/concepts.md
43-
- Trainings:
43+
- Trainings:
4444
- Training offer overview: getting_started/training_overview.md
4545
- Register for a training course: getting_started/register_training.md
4646
- Workspace setup:
@@ -88,11 +88,11 @@ nav:
8888
- Intelligence: cti/features/consume/intelligence.md
8989
- Observables: cti/features/consume/observables.md
9090
- Telemetry: cti/features/consume/telemetry.md
91-
- Feeds:
92-
- Understand the feeds: cti/features/consume/feeds.md
93-
- Create feeds: cti/features/consume/create_feed.md
94-
- Manage feeds: cti/features/consume/manage_feeds.md
95-
- Create a detection rule from a feed: cti/features/consume/create_detection_rule_from_feed.md
91+
- Feeds:
92+
- Understand the feeds: cti/features/consume/feeds.md
93+
- Create feeds: cti/features/consume/create_feed.md
94+
- Manage feeds: cti/features/consume/manage_feeds.md
95+
- Create a detection rule from a feed: cti/features/consume/create_detection_rule_from_feed.md
9696
- Graph Explorations: cti/features/consume/graph_explorations.md
9797
- Export: cti/features/consume/export.md
9898
- IOCs Collections: cti/features/consume/ioccollections.md
@@ -107,7 +107,7 @@ nav:
107107
- MISP Feed: cti/features/integrations/misp.md
108108
- MISP - Import to IOC Collection: cti/features/integrations/misp_ids_to_ioc_collection.md
109109
- Microsoft Sentinel: cti/features/integrations/microsoft-sentinel.md
110-
- OpenCTI Import Connector: cti/features/integrations/opencti.md
110+
- OpenCTI Import Connector: cti/features/integrations/opencti.md
111111
- OpenCTI Stream Connector: cti/features/integrations/opencti-stream-connector.md
112112
- Splunk: cti/features/integrations/splunk.md
113113
- Splunk SOAR: cti/features/integrations/splunk_soar.md
@@ -124,10 +124,10 @@ nav:
124124
- Intakes: xdr/features/collect/intakes.md
125125
- Entities: xdr/features/collect/entities.md
126126
- Assets: xdr/features/collect/assets.md
127-
- Optimization rules:
128-
- Optimization rules overview: xdr/features/collect/optimization_rules_overview.md
129-
- Create an optimization rule: xdr/features/collect/create_optimization_rule.md
130-
- Optimization rules technical references: xdr/features/collect/optimization_rules_reference.md
127+
- Optimization rules:
128+
- Optimization rules overview: xdr/features/collect/optimization_rules_overview.md
129+
- Create an optimization rule: xdr/features/collect/create_optimization_rule.md
130+
- Optimization rules technical references: xdr/features/collect/optimization_rules_reference.md
131131
- Detect:
132132
- IOCs Detection: xdr/features/detect/iocdetection.md
133133
- Rules Catalog: xdr/features/detect/rules_catalog.md
@@ -139,17 +139,17 @@ nav:
139139
- Alerts: xdr/features/investigate/alerts.md
140140
- Events page: xdr/features/investigate/events.md
141141
- Massive event export:
142-
- Understand massive event export: xdr/features/investigate/event_export.md
142+
- Understand massive event export: xdr/features/investigate/event_export.md
143143
- Export events with CLI: xdr/features/investigate/export_event_cli.md
144144
- Export events with API: xdr/features/investigate/export_event_API.md
145-
- Massive export technical specifications: xdr/features/investigate/export_reference.md
145+
- Massive export technical specifications: xdr/features/investigate/export_reference.md
146146
- Massive event export troubleshooting: xdr/features/investigate/export_event_bulk_troubleshooting.md
147-
- Cases:
147+
- Cases:
148148
- Cases overview: xdr/features/investigate/cases.md
149-
- Create and manage cases:
149+
- Create and manage cases:
150150
- Create a case: xdr/features/investigate/create_a_case.md
151151
- Manage cases: xdr/features/investigate/manage_cases.md
152-
- Investigate cases:
152+
- Investigate cases:
153153
- Investigate case details: xdr/features/investigate/case_details.md
154154
- Graph investigation: xdr/features/investigate/graph_investigation.md
155155
- AI Cases: xdr/features/investigate/ai_cases.md
@@ -174,9 +174,9 @@ nav:
174174
- How-to guides: xdr/features/investigate/sol_how_to_guides.md
175175
- SOL Datasets: xdr/features/investigate/sol_datasets.md
176176
- Query examples: xdr/features/investigate/sol_query_examples.md
177-
- "Reference: Datasources": xdr/features/investigate/sol_ref_datasources.md
178-
- "Reference: Operators": xdr/features/investigate/sol_ref_operators.md
179-
- "Reference: Functions": xdr/features/investigate/sol_ref_functions.md
177+
- 'Reference: Datasources': xdr/features/investigate/sol_ref_datasources.md
178+
- 'Reference: Operators': xdr/features/investigate/sol_ref_operators.md
179+
- 'Reference: Functions': xdr/features/investigate/sol_ref_functions.md
180180
- Notebooks: xdr/features/investigate/notebooks.md
181181
- Report:
182182
- Dashboards:
@@ -203,14 +203,13 @@ nav:
203203
- Palo Alto Cortex XSOAR: xdr/features/integrations/interconnect_sekoia_with_xsoar.md
204204
- Swimlane Turbine: xdr/features/integrations/swimlane_turbine.md
205205
- Asset Intelligence (Reveal):
206-
- Reveal overview: xdr/features/modules/reveal_index.md
207-
- Get started with Reveal: xdr/features/modules/reveal_getting_started.md
208-
- Explore assets context: xdr/features/modules/reveal_asset_context_panel.md
209-
- Visualize attack paths: xdr/features/investigate/attack_path_visualization.md
210-
- Discover Points of Interest: xdr/features/detect/points_of_interest.md
211-
- Check asset connector health: xdr/features/collect/asset_connector_health.md
212-
- Reveal enablement matrix: xdr/features/modules/reveal_feature_enablement.md
213-
206+
- Reveal overview: xdr/features/modules/reveal_index.md
207+
- Get started with Reveal: xdr/features/modules/reveal_getting_started.md
208+
- Explore assets context: xdr/features/modules/reveal_asset_context_panel.md
209+
- Visualize attack paths: xdr/features/investigate/attack_path_visualization.md
210+
- Discover Points of Interest: xdr/features/detect/points_of_interest.md
211+
- Check asset connector health: xdr/features/collect/asset_connector_health.md
212+
- Reveal enablement matrix: xdr/features/modules/reveal_feature_enablement.md
214213
- Usecases:
215214
- Export large volumes of events: xdr/usecases/massive_export.md
216215
- Implement a blocklist in Sekoia.io: xdr/usecases/playbook/implement_blocklist.md
@@ -236,13 +235,12 @@ nav:
236235
- Assets: xdr/FAQ/Assets_qa.md
237236
- Ingestion:
238237
- Delay with event ingestion or alert creation: xdr/FAQ/ingestion/ingestion_delay.md
239-
- Subscriptions:
238+
- Subscriptions:
240239
- Allocate trial subscription: xdr/FAQ/subscriptions/allocate_trial_subscription.md
241240
- Subscriptions notifications: xdr/FAQ/subscriptions/subscriptions_notifications.md
242241
- Sekoia.io Endpoint agent: xdr/FAQ/SEKOIA_Endpoint_Agent.md
243242
- Datetime representation: xdr/FAQ/datetime.md
244243
- Reveal troubleshooting: xdr/features/modules/reveal_troubleshoot.md
245-
246244
- Integrations:
247245
- Introduction: integration/index.md
248246
- Ingestion methods:
@@ -508,7 +506,6 @@ nav:
508506
- Threat Intelligence:
509507
- Prodaft USTA: integration/categories/threat_intelligence/prodaft_usta.md
510508
- List of Playbooks Actions:
511-
- Overview: integration/action_library/overview.md
512509
- Applicative:
513510
- ElasticSearch: integration/action_library/elasticsearch.md
514511
- Mandrill: integration/action_library/mandrill.md
@@ -547,6 +544,7 @@ nav:
547544
- OpenAI: integration/action_library/openai.md
548545
- RSS: integration/action_library/rss.md
549546
- Sekoia.io: integration/action_library/sekoia-io.md
547+
- Sekoia.io: integration/action_library/sekoia-io.md
550548
- Utils: integration/action_library/utils.md
551549
- IAM:
552550
- Microsoft Active Directory: integration/action_library/microsoft-active-directory.md
@@ -555,6 +553,7 @@ nav:
555553
- Fortigate Firewalls: integration/action_library/fortigate-firewalls.md
556554
- Sophos: integration/action_library/sophos.md
557555
- Zscaler: integration/action_library/zscaler.md
556+
- Overview: integration/action_library/overview.md
558557
- Threat Intelligence:
559558
- Censys: integration/action_library/censys.md
560559
- Certificate Transparency: integration/action_library/certificate-transparency.md
@@ -622,11 +621,11 @@ plugins:
622621
- search: null
623622
- redirects:
624623
redirect_maps:
625-
xdr/features/investigate/sekoia_operating_language.md: xdr/features/investigate/sol_overview.md
626624
getting_started/2fa.md: getting_started/account_security.md
627625
getting_started/apikey_creation.md: getting_started/manage_api_keys.md
628626
getting_started/first_steps.md: getting_started/index.md
629627
getting_started/inviting_users_to_join_your_community.md: getting_started/invite_users.md
628+
integration/categories/network/beyondtrust_pra_sessions.md: integration/categories/iam/beyondtrust_pra_sessions.md
630629
intelligence_center.md: cti/index.md
631630
intelligence_center/dashboard.md: cti/features/monitor/dashboard.md
632631
intelligence_center/data_export.md: cti/features/consume/export.md
@@ -839,7 +838,7 @@ plugins:
839838
xdr/features/collect/integrations/network/wallix.md: integration/categories/iam/wallix.md
840839
xdr/features/collect/integrations/network/watchguard_firebox.md: integration/categories/network_security/watchguard_firebox.md
841840
xdr/features/investigate/dork_language.md: xdr/features/investigate/events_query_language.md
842-
integration/categories/network/beyondtrust_pra_sessions.md: integration/categories/iam/beyondtrust_pra_sessions.md
841+
xdr/features/investigate/sekoia_operating_language.md: xdr/features/investigate/sol_overview.md
843842
- integration_by_uuid
844843
- sass
845844
repo_url: https://github.com/SEKOIA-IO/documentation

0 commit comments

Comments
 (0)