Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Only merge when 8.16 becomes current][8.x] Direct users to new API reference site (backport #5911) #5914

Open
wants to merge 1 commit into
base: 8.x
Choose a base branch
from
Open
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[anonymization-fields-api-find]]
=== Find anonymization fields

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
--

Retrieve a list of anonymization fields that can be included in the LLM context.

[discrete]
Expand Down
6 changes: 6 additions & 0 deletions docs/AI-for-security/api/assistant-api-overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,10 @@
[role="xpack"]
== Elastic AI Assistant API

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
--

The Elastic AI Assistant API allows you to interact with and manage Elastic AI Assistant.
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[bulk-actions-anonymization-fields-api]]
=== Bulk anonymization field actions

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
--

Apply a bulk action (create, update, or delete) to multiple anonymization fields. The bulk action is applied to all anonymization fields that match the filter or to the list of anonymization fields by their IDs.

[discrete]
Expand Down
6 changes: 6 additions & 0 deletions docs/AI-for-security/api/bulk-actions-prompts-api.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[bulk-actions-prompts-api]]
=== Bulk prompt actions

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
--

Apply a bulk action (create, update, or delete) to multiple prompts. The bulk action is applied to all prompts that match the filter or to the list of prompts by their IDs.

[discrete]
Expand Down
6 changes: 6 additions & 0 deletions docs/AI-for-security/api/chat-complete-api.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[chat-complete-api]]
=== Complete chat

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
--

The complete chat API allows you to communicate with the configured large language model (LLM) and, if needed, persist the result as a conversation (create new or extend existing).

[discrete]
Expand Down
6 changes: 6 additions & 0 deletions docs/AI-for-security/api/conversation-api-create.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[conversation-api-create]]
=== Create conversation

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
--

Create a new Elastic AI Assistant conversation.

[discrete]
Expand Down
6 changes: 6 additions & 0 deletions docs/AI-for-security/api/conversation-api-delete.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[conversation-api-delete]]
=== Delete conversation

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
--

Delete an existing Elastic AI Assistant conversation by conversation ID.

[discrete]
Expand Down
6 changes: 6 additions & 0 deletions docs/AI-for-security/api/conversation-api-find.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[conversation-api-find]]
=== Find conversations

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
--

Retrieve a list of Elastic AI Assistant conversations for the current user.

[discrete]
Expand Down
6 changes: 6 additions & 0 deletions docs/AI-for-security/api/conversation-api-get.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[conversation-api-get]]
=== Get conversation

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
--

Retrieve an existing Elastic AI Assistant conversation by conversation ID.

[discrete]
Expand Down
6 changes: 6 additions & 0 deletions docs/AI-for-security/api/conversation-api-update.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[conversation-api-update]]
=== Update conversation

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
--

Update an existing Elastic AI Assistant conversation by conversation ID.

==== Request URL
Expand Down
6 changes: 6 additions & 0 deletions docs/AI-for-security/api/prompts-api-find.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[prompts-api-find]]
=== Find prompts

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
--

Retrieve a list of Elastic AI Assistant prompts.

[discrete]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[asset-criticality-api-bulk-upsert]]
=== Bulk upsert (create or update) asset criticality records

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-entity-analytics-api[Entity Analytics APIs].
--

Create or update asset criticality records for multiple entities.

If asset criticality records already exist for the entities specified in the request, this API overwrites those records with the specified values.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[delete-criticality-api-delete]]
=== Delete asset criticality record

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-entity-analytics-api[Entity Analytics APIs].
--

Delete a single asset criticality record by ID field and ID value.

==== Request URL
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[asset-criticality-api-get]]
=== Get asset criticality record

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-entity-analytics-api[Entity Analytics APIs].
--

Retrieve a single asset criticality record by ID field and ID value.

==== Request URL
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[asset-criticality-api-list]]
=== List asset criticality records

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-entity-analytics-api[Entity Analytics APIs].
--

Retrieve a list of asset criticality records.

Use the query parameters to filter and sort the results as needed. By default, the first page is returned, with 10 results per page.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,10 @@
[role="xpack"]
== Asset criticality API

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-entity-analytics-api[Entity Analytics APIs].
--

You can manage <<asset-criticality, asset criticality>> records through the API. To use this API, you must first turn on the `securitySolution:enableAssetCriticality` <<enable-asset-criticality, advanced setting>>.
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[asset-criticality-api-upsert]]
=== Upsert (create or update) asset criticality record

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-entity-analytics-api[Entity Analytics APIs].
--

Create or update an asset criticality record.

If an asset criticality record already exists for the entity specified in the request, this API overwrites that record with the specified value.
Expand Down
6 changes: 6 additions & 0 deletions docs/cases/api/actions-api/cases-actions-api-intro.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
[role="xpack"]
== Actions API (for pushing cases to external systems)

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-cases[cases APIs] and {api-kibana}/group/endpoint-connectors[connectors APIs].
--

You can push {elastic-sec} cases to these third-party systems:

* {sn}
Expand Down
6 changes: 6 additions & 0 deletions docs/cases/api/cases-api/cases-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
[role="xpack"]
== Cases API

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-cases[cases APIs] and {api-kibana}/group/endpoint-connectors[connectors APIs].
--

You can create, manage, configure, and send cases to external systems with these APIs:

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}"`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[exceptions-api-create-container]]
=== Create exception container

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-exceptions-api[exceptions APIs].
--

Creates an exception container.

An exception container groups <<exceptions-api-create-exception-item, exception items>>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[exceptions-api-create-exception-item]]
=== Create exception item

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-exceptions-api[exceptions APIs].
--

Creates an exception item and associates it with the specified
<<exceptions-api-create-container, exception container>>.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[exceptions-api-create-shared-exception-list]]
=== Create shared exception list

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-exceptions-api[exceptions APIs].
--

Creates a shared exception list.

An exception list groups <<exceptions-api-create-exception-item, exception items>>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[exceptions-api-delete-container]]
=== Delete exception container

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-exceptions-api[exceptions APIs].
--

Deletes an exception container.

==== Request URL
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[exceptions-api-delete-item]]
=== Delete exception item

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-exceptions-api[exceptions APIs].
--

Deletes an exception item.

==== Request URL
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[exceptions-api-export-exception-list]]
=== Export exception list

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-exceptions-api[exceptions APIs].
--

Exports an exception list and its associated items to an `.ndjson` file.

==== Request URL
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[exceptions-api-find-exception-containers]]
=== Find exception containers

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-exceptions-api[exceptions APIs].
--

Retrieves a paginated subset of exception containers. By default, the first
page is returned with 20 results per page.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[exceptions-api-find-exception-items]]
=== Find exception items

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-exceptions-api[exceptions APIs].
--

Retrieves a paginated subset of exception items in the specified container. By
default, the first page is returned with 20 results per page.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[exceptions-api-get-container]]
=== Get exception container

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-exceptions-api[exceptions APIs].
--

Retrieves an exception container using its `id` or `list_id` field.

==== Request URL
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[exceptions-api-get-item]]
=== Get exception item

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-exceptions-api[exceptions APIs].
--

Retrieves an exception item using its `id` or `item_id` field.

==== Request URL
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[exceptions-api-import-exception-list]]
=== Import exception list

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-exceptions-api[exceptions APIs].
--

Imports an exception list and associated items.

An exception list groups <<exceptions-api-create-exception-item, exception items>>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[[exceptions-api-summary-exception-container]]
=== Summary exception container

.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-exceptions-api[exceptions APIs].
--

Retrieves an exception container summary.

==== Request URL
Expand Down
Loading