mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
33a71e3289
* Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
111 lines
4.7 KiB
Text
111 lines
4.7 KiB
Text
[[rest-apis]]
|
|
= REST APIs
|
|
|
|
[partintro]
|
|
--
|
|
{es} exposes REST APIs that are used by the UI components and can be called
|
|
directly to configure and access {es} features.
|
|
|
|
[NOTE]
|
|
We are working on including more {es} APIs in this section. Some content might
|
|
not be included yet.
|
|
|
|
* <<api-conventions, API conventions>>
|
|
* <<common-options, Common Options>>
|
|
* <<rest-api-compatibility, REST API Compatibility>>
|
|
* <<autoscaling-apis, Autoscaling APIs>>
|
|
* <<behavioral-analytics-apis, Behavioral Analytics APIs>>
|
|
* <<cat, cat APIs>>
|
|
* <<cluster, Cluster APIs>>
|
|
* <<features-apis,Features APIs>>
|
|
* <<connector-apis, Connector APIs>>
|
|
* <<ccr-apis,{ccr-cap} APIs>>
|
|
* <<data-stream-apis,Data stream APIs>>
|
|
* <<docs, Document APIs>>
|
|
* <<enrich-apis,Enrich APIs>>
|
|
* <<eql-apis,EQL search APIs>>
|
|
* <<esql-apis,{esql} query APIs>>
|
|
* <<fleet-apis,Fleet APIs>>
|
|
* <<graph-explore-api,Graph explore API>>
|
|
* <<indices, Index APIs>>
|
|
* <<index-lifecycle-management-api,Index lifecycle management APIs>>
|
|
* <<inference-apis,Inference APIs>>
|
|
* <<info-api,Info API>>
|
|
* <<ingest-apis,Ingest APIs>>
|
|
* <<licensing-apis,Licensing APIs>>
|
|
* <<logstash-apis,Logstash APIs>>
|
|
* <<ml-apis,{ml-cap} APIs>>
|
|
* <<ml-ad-apis,{ml-cap} {anomaly-detect} APIs>>
|
|
* <<ml-df-analytics-apis,{ml-cap} {dfanalytics} APIs>>
|
|
* <<ml-df-trained-models-apis,{ml-cap} trained model APIs>>
|
|
* <<migration-api,Migration APIs>>
|
|
* <<node-lifecycle-api,Node lifecycle API>>
|
|
* <<query-rules-apis,Query rules APIs>>
|
|
* <<indices-reload-analyzers,Reload search analyzers API>>
|
|
* <<repositories-metering-apis,Repositories metering APIs>>
|
|
* <<rollup-apis,Rollup APIs>>
|
|
* <<rest-api-root,Root API>>
|
|
* <<script-apis,Script APIs>>
|
|
* <<search, Search APIs>>
|
|
* <<search-application-apis, Search Application APIs>>
|
|
* <<searchable-snapshots-apis, Searchable snapshots APIs>>
|
|
* <<security-api,Security APIs>>
|
|
* <<snapshot-restore-apis,Snapshot and restore APIs>>
|
|
* <<snapshot-lifecycle-management-api,Snapshot lifecycle management APIs>>
|
|
* <<sql-apis,SQL APIs>>
|
|
* <<synonyms-apis,Synonyms APIs>>
|
|
* <<text-structure-apis,Text structure APIs>>
|
|
* <<transform-apis,{transform-cap} APIs>>
|
|
* <<usage-api,Usage API>>
|
|
* <<watcher-api,Watcher APIs>>
|
|
--
|
|
|
|
include::{es-ref-dir}/api-conventions.asciidoc[]
|
|
include::{es-ref-dir}/rest-api/common-options.asciidoc[]
|
|
include::{es-ref-dir}/rest-api/rest-api-compatibility.asciidoc[]
|
|
include::{es-ref-dir}/autoscaling/apis/autoscaling-apis.asciidoc[]
|
|
include::{es-ref-dir}/behavioral-analytics/apis/index.asciidoc[]
|
|
include::{es-ref-dir}/cat.asciidoc[]
|
|
include::{es-ref-dir}/cluster.asciidoc[]
|
|
include::{es-ref-dir}/ccr/apis/ccr-apis.asciidoc[]
|
|
include::{es-ref-dir}/connector/apis/connector-apis.asciidoc[]
|
|
include::{es-ref-dir}/data-streams/data-stream-apis.asciidoc[]
|
|
include::{es-ref-dir}/docs.asciidoc[]
|
|
include::{es-ref-dir}/ingest/apis/enrich/index.asciidoc[]
|
|
include::{es-ref-dir}/eql/eql-apis.asciidoc[]
|
|
include::{es-ref-dir}/esql/esql-apis.asciidoc[]
|
|
include::{es-ref-dir}/features/apis/features-apis.asciidoc[]
|
|
include::{es-ref-dir}/fleet/index.asciidoc[]
|
|
include::{es-ref-dir}/graph/explore.asciidoc[]
|
|
include::{es-ref-dir}/indices.asciidoc[]
|
|
include::{es-ref-dir}/ilm/apis/ilm-api.asciidoc[]
|
|
include::{es-ref-dir}/inference/inference-apis.asciidoc[]
|
|
include::info.asciidoc[]
|
|
include::{es-ref-dir}/ingest/apis/index.asciidoc[]
|
|
include::{es-ref-dir}/licensing/index.asciidoc[]
|
|
include::{es-ref-dir}/rest-api/logstash/index.asciidoc[]
|
|
include::{es-ref-dir}/ml/common/apis/index.asciidoc[]
|
|
include::{es-ref-dir}/ml/anomaly-detection/apis/index.asciidoc[]
|
|
include::{es-ref-dir}/ml/df-analytics/apis/index.asciidoc[]
|
|
include::{es-ref-dir}/ml/trained-models/apis/index.asciidoc[]
|
|
include::{es-ref-dir}/migration/migration.asciidoc[]
|
|
include::{es-ref-dir}/shutdown/apis/shutdown-api.asciidoc[]
|
|
include::{es-ref-dir}/query-rules/apis/index.asciidoc[]
|
|
include::{es-ref-dir}/indices/apis/reload-analyzers.asciidoc[]
|
|
include::{es-ref-dir}/repositories-metering-api/repositories-metering-apis.asciidoc[]
|
|
include::{es-ref-dir}/rollup/rollup-apis.asciidoc[]
|
|
include::{es-ref-dir}/rest-api/root.asciidoc[]
|
|
include::{es-ref-dir}/scripting/apis/script-apis.asciidoc[]
|
|
include::{es-ref-dir}/search.asciidoc[]
|
|
include::{es-ref-dir}/search-application/apis/index.asciidoc[]
|
|
include::{es-ref-dir}/searchable-snapshots/apis/searchable-snapshots-apis.asciidoc[]
|
|
include::{es-ref-dir}/rest-api/security.asciidoc[]
|
|
include::{es-ref-dir}/snapshot-restore/apis/snapshot-restore-apis.asciidoc[]
|
|
include::{es-ref-dir}/slm/apis/slm-api.asciidoc[]
|
|
include::{es-ref-dir}/sql/apis/sql-apis.asciidoc[]
|
|
include::{es-ref-dir}/synonyms/apis/synonyms-apis.asciidoc[]
|
|
include::{es-ref-dir}/text-structure/apis/index.asciidoc[]
|
|
include::{es-ref-dir}/transform/apis/index.asciidoc[]
|
|
include::usage.asciidoc[]
|
|
include::{es-ref-dir}/rest-api/watcher.asciidoc[]
|
|
include::defs.asciidoc[]
|