root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/docs/reference/rest-api/index.asciidoc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

84 lines
3.4 KiB
Plaintext
Raw Normal View History

[DOCS] Change 'X-Pack APIs' section to 'REST APIs' (#43451)
2019-06-27 01:44:33 +08:00
[[rest-apis]]
= REST APIs
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
[partintro]
--
[DOCS] Change 'X-Pack APIs' section to 'REST APIs' (#43451)
2019-06-27 01:44:33 +08:00
{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.
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
* <<api-conventions, API conventions>>
[DOCS] Add info about GET/POST to the API conventions. (#74529) * [DOCS] Add info about GET/POST to the API conventions. * Fixed anchor * Added redirect * Incorporated review suggestions
2021-07-01 00:24:42 +08:00
* <<common-options, Common Options>>
Include autoscaling APIs in API docs (#54603) This commit adds a top-level link to the autoscaling API reference page to the API docs. Additionally, we add a conditional guard on the API pages to only include them in development builds of the docs.
2020-04-02 03:43:44 +08:00
* <<autoscaling-apis, Autoscaling APIs>>
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
* <<cat, cat APIs>>
* <<cluster, Cluster APIs>>
Change Get Snapshottable Features endpoint to `_features` (#69755) The endpoint `_snapshottable_features` is long and implies incorrect things about this API - it is used not just for snapshots, but also for the upcoming reset API. Following discussions on the team, this commit changes the endpoint to `_features` and removes the connection between this API and snapshots, as snapshots are not the only use for the output of this API.
2021-03-03 02:30:02 +08:00
* <<features-apis,Features APIs>>
[DOCS] Replaces CCR terms with attributes (#39516)
2019-03-13 05:27:17 +08:00
* <<ccr-apis,{ccr-cap} APIs>>
[DOCS] Add data stream APIs to main API page (#58204)
2020-06-18 21:05:56 +08:00
* <<data-stream-apis,Data stream APIs>>
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
* <<docs, Document APIs>>
[DOCS] Separate Enrich API Docs (#46286) * Add enrich policy common parameter * Add enrich APIs to REST APIs index * Add put enrich policy API docs * Add get enrich policy API docs * Add delete enrich policy API docs * Add execute enrich policy API docs
2019-09-05 02:11:52 +08:00
* <<enrich-apis,Enrich APIs>>
[DOCS] Fixes italics and capitalization (#69387)
2021-02-23 05:20:06 +08:00
* <<graph-explore-api,Graph explore API>>
* <<find-structure,Find structure API>>
Add fleet polling API for global checkpoint (#71093) Fleet server needs an API to access up to date global checkpoints for indices. Additionally, it requires a mode of operation when fleet can provide its current knowledge about the global checkpoints and poll for advancements. This commit introduces this API in the fleet plugin.
2021-04-15 01:19:33 +08:00
* <<fleet-apis,Fleet APIs>>
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
* <<indices, Index APIs>>
[DOCS] Fixed edit links for ILM APIs and added the APIs to the REST ref (#35070) * [DOCS] Fixed edit links for ILM APIs and added the APIs to the REST API section. * [DOCS] Fixed link to ILM APIs.
2018-10-31 09:27:43 +08:00
* <<index-lifecycle-management-api,Index lifecycle management APIs>>
[DOCS] Relocate Ingest API docs to REST API section (#45812)
2019-08-23 23:54:40 +08:00
* <<ingest-apis,Ingest APIs>>
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
* <<info-api,Info API>>
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
* <<licensing-apis,Licensing APIs>>
Logstash Pipeline REST api spec and documentation (#67788) This commit adds REST api specifications for the Logstash Pipeline APIs and documentation of the APIs. Closes #67360
2021-01-29 01:50:16 +08:00
* <<logstash-apis,Logstash APIs>>
[DOCS] Separates data frame analytics APIs (#44451) * [DOCS] Separates data frame analytics APIs * [DOCS] Adds links between new pages
2019-07-17 04:22:27 +08:00
* <<ml-apis,{ml-cap} {anomaly-detect} APIs>>
* <<ml-df-analytics-apis,{ml-cap} {dfanalytics} APIs>>
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
* <<migration-api,Migration APIs>>
[DOCS] Fixes italics and capitalization (#69387)
2021-02-23 05:20:06 +08:00
* <<indices-reload-analyzers,Reload search analyzers API>>
* <<repositories-metering-apis,Repositories metering APIs>>
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
* <<rollup-apis,Rollup APIs>>
[DOCS] Document create stored script API (#71493)
2021-04-19 21:19:12 +08:00
* <<script-apis,Script APIs>>
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
* <<search, Search APIs>>
Merge feature/searchable-snapshots branch into master (#54803) This commit merges the searchable-snapshots feature branch into master. See #54803 for the complete list of squashed commits. Co-authored-by: David Turner <david.turner@elastic.co> Co-authored-by: Yannick Welsch <yannick@welsch.lu> Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com> Co-authored-by: Andrei Dan <andrei.dan@elastic.co>
2020-04-06 21:51:05 +08:00
* <<searchable-snapshots-apis, Searchable snapshots APIs>>
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
* <<security-api,Security APIs>>
[DOCS] Add clean up snapshot repository API docs (#56519)
2020-05-12 20:56:29 +08:00
* <<snapshot-restore-apis,Snapshot and restore APIs>>
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
* <<snapshot-lifecycle-management-api,Snapshot lifecycle management APIs>>
[DOCS] Update data frame transform URLs (#46940)
2019-09-21 04:26:57 +08:00
* <<transform-apis,{transform-cap} APIs>>
[DOCS] Adds X-Pack usage API (#52496)
2020-02-21 01:25:57 +08:00
* <<usage-api,Usage API>>
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
* <<watcher-api,Watcher APIs>>
--
[DOCS] Move Elasticsearch APIs to REST APIs section. (#44238) (#44372) Moves the following API sections under the REST APIs navigations: - API Conventions - Document APIs - Search APIs - Index APIs (previously named Indices APIs) - cat APIs - Cluster APIs Other supporting changes: - Removes the previous index APIs page under REST APIs. Adds a redirect for the removed page. - Removes several [partintro] macros so the docs build correctly. - Changes anchors for pages that become sections of a parent page. - Adds several redirects for existing pages that become sections of a parent page. This commit re-applies changes from #44238. Changes from that PR were reverted due to broken links in several repos. This commit adds redirects for those broken links.
2019-07-17 20:49:22 +08:00
include::{es-repo-dir}/api-conventions.asciidoc[]
[DOCS] Add info about GET/POST to the API conventions. (#74529) * [DOCS] Add info about GET/POST to the API conventions. * Fixed anchor * Added redirect * Incorporated review suggestions
2021-07-01 00:24:42 +08:00
include::{es-repo-dir}/rest-api/common-options.asciidoc[]
Add autoscaling API skelton (#51564) The main purpose of this commit is to add a single autoscaling REST endpoint skeleton, for the purpose of starting to build out the build and testing infrastructure that will surround it. For example, rather than commiting a fully-functioning autoscaling API, we introduce here the skeleton so that we can start wiring up the build and testing infrastructure, establish security roles/permissions, an so on. This way, in a forthcoming PR that introduces actual functionality, that PR will be smaller and have less distractions around that sort of infrastructure.
2020-02-07 08:15:17 +08:00
include::{es-repo-dir}/autoscaling/apis/autoscaling-apis.asciidoc[]
[DOCS] Move Elasticsearch APIs to REST APIs section. (#44238) (#44372) Moves the following API sections under the REST APIs navigations: - API Conventions - Document APIs - Search APIs - Index APIs (previously named Indices APIs) - cat APIs - Cluster APIs Other supporting changes: - Removes the previous index APIs page under REST APIs. Adds a redirect for the removed page. - Removes several [partintro] macros so the docs build correctly. - Changes anchors for pages that become sections of a parent page. - Adds several redirects for existing pages that become sections of a parent page. This commit re-applies changes from #44238. Changes from that PR were reverted due to broken links in several repos. This commit adds redirects for those broken links.
2019-07-17 20:49:22 +08:00
include::{es-repo-dir}/cat.asciidoc[]
include::{es-repo-dir}/cluster.asciidoc[]
Introduce cross-cluster replication API docs (#34726) This commit is our first introduction to cross-cluster replication docs. In this commit, we introduce the cross-cluster replication API docs. We also add skelton docs for additional content that will be added in a series of follow-up commits.
2018-10-26 23:23:35 +08:00
include::{es-repo-dir}/ccr/apis/ccr-apis.asciidoc[]
[DOCS] Reformat data streams intro and overview (#57954) Changes: * Updates 'Data streams' intro page to focus on problem solution and benefits. * Adds 'Data streams overview' page to cover conceptual information, based on existing content in the 'Data streams' intro. * Adds diagrams for data streams and search/indexing request examples. * Moves API jump list and API docs to a new 'Data streams APIs' section. Links to these APIs will be available through tutorials. * Add xrefs to existing docs for concepts like generation, write index, and append-only.
2020-06-11 23:17:21 +08:00
include::{es-repo-dir}/data-streams/data-stream-apis.asciidoc[]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
include::{es-repo-dir}/docs.asciidoc[]
[DOCS] Separate Enrich API Docs (#46286) * Add enrich policy common parameter * Add enrich APIs to REST APIs index * Add put enrich policy API docs * Add get enrich policy API docs * Add delete enrich policy API docs * Add execute enrich policy API docs
2019-09-05 02:11:52 +08:00
include::{es-repo-dir}/ingest/apis/enrich/index.asciidoc[]
Change Get Snapshottable Features endpoint to `_features` (#69755) The endpoint `_snapshottable_features` is long and implies incorrect things about this API - it is used not just for snapshots, but also for the upcoming reset API. Following discussions on the team, this commit changes the endpoint to `_features` and removes the connection between this API and snapshots, as snapshots are not the only use for the output of this API.
2021-03-03 02:30:02 +08:00
include::{es-repo-dir}/features/apis/features-apis.asciidoc[]
Add fleet polling API for global checkpoint (#71093) Fleet server needs an API to access up to date global checkpoints for indices. Additionally, it requires a mode of operation when fleet can provide its current knowledge about the global checkpoints and poll for advancements. This commit introduces this API in the fleet plugin.
2021-04-15 01:19:33 +08:00
include::{es-repo-dir}/fleet/index.asciidoc[]
[DOCS] Move find file structure to a new API endpoint (#67314)
2021-01-13 03:59:45 +08:00
include::{es-repo-dir}/text-structure/apis/find-structure.asciidoc[leveloffset=+1]
[DOCS] Moves graph to docs folder (#33472)
2018-09-27 05:59:31 +08:00
include::{es-repo-dir}/graph/explore.asciidoc[]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
include::{es-repo-dir}/indices.asciidoc[]
[DOCS] Fixed edit links for ILM APIs and added the APIs to the REST ref (#35070) * [DOCS] Fixed edit links for ILM APIs and added the APIs to the REST API section. * [DOCS] Fixed link to ILM APIs.
2018-10-31 09:27:43 +08:00
include::{es-repo-dir}/ilm/apis/ilm-api.asciidoc[]
[DOCS] Relocate Ingest API docs to REST API section (#45812)
2019-08-23 23:54:40 +08:00
include::{es-repo-dir}/ingest/apis/index.asciidoc[]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
include::info.asciidoc[]
[DOCS] Move licensing APIs to docs (#31445)
2018-06-20 23:17:11 +08:00
include::{es-repo-dir}/licensing/index.asciidoc[]
Logstash Pipeline REST api spec and documentation (#67788) This commit adds REST api specifications for the Logstash Pipeline APIs and documentation of the APIs. Closes #67360
2021-01-29 01:50:16 +08:00
include::{xes-repo-dir}/rest-api/logstash/index.asciidoc[]
[DOCS] Changes level offset for anomaly detection APIs (#59920)
2020-07-21 03:38:09 +08:00
include::{es-repo-dir}/ml/anomaly-detection/apis/index.asciidoc[]
[DOCS] Separates data frame analytics APIs (#44451) * [DOCS] Separates data frame analytics APIs * [DOCS] Adds links between new pages
2019-07-17 04:22:27 +08:00
include::{es-repo-dir}/ml/df-analytics/apis/index.asciidoc[]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
include::{es-repo-dir}/migration/migration.asciidoc[]
include::{es-repo-dir}/indices/apis/reload-analyzers.asciidoc[]
Add repositories metering API (#60371) This pull request adds a new set of APIs that allows tracking the number of requests performed by the different registered repositories. In order to avoid losing data, the repository statistics are archived after the repository is closed for a configurable retention period `repositories.stats.archive.retention_period`. The API exposes the statistics for the active repositories as well as the modified/closed repositories.
2020-09-08 16:44:54 +08:00
include::{es-repo-dir}/repositories-metering-api/repositories-metering-apis.asciidoc[]
[DOCS] Add rollup V2 API docs (#65398) Changes: * Documents new `<index>/_rollup` API * Updates rollup APIs overview page * Enables rollups V2 in docs integ tests
2020-11-26 00:16:06 +08:00
include::{es-repo-dir}/rollup/rollup-apis.asciidoc[]
[DOCS] Document create stored script API (#71493)
2021-04-19 21:19:12 +08:00
include::{es-repo-dir}/scripting/apis/script-apis.asciidoc[]
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-20 02:35:36 +08:00
include::{es-repo-dir}/search.asciidoc[]
Merge feature/searchable-snapshots branch into master (#54803) This commit merges the searchable-snapshots feature branch into master. See #54803 for the complete list of squashed commits. Co-authored-by: David Turner <david.turner@elastic.co> Co-authored-by: Yannick Welsch <yannick@welsch.lu> Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com> Co-authored-by: Andrei Dan <andrei.dan@elastic.co>
2020-04-06 21:51:05 +08:00
include::{es-repo-dir}/searchable-snapshots/apis/searchable-snapshots-apis.asciidoc[]
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
include::{xes-repo-dir}/rest-api/security.asciidoc[]
[DOCS] Add clean up snapshot repository API docs (#56519)
2020-05-12 20:56:29 +08:00
include::{es-repo-dir}/snapshot-restore/apis/snapshot-restore-apis.asciidoc[]
[DOCS] Align with ILM API docs (#48705) * [DOCS] Reconciled with Snapshot/Restore reorg
2020-01-22 11:58:17 +08:00
include::{es-repo-dir}/slm/apis/slm-api.asciidoc[]
[DOCS] Removes data-frames folder (#46760)
2019-09-17 01:23:46 +08:00
include::{es-repo-dir}/transform/apis/index.asciidoc[]
[DOCS] Adds X-Pack usage API (#52496)
2020-02-21 01:25:57 +08:00
include::usage.asciidoc[]
[DOCS] Creates rest-api folder in docs
2018-06-06 07:43:55 +08:00
include::{xes-repo-dir}/rest-api/watcher.asciidoc[]
[DOCS] Moves machine learning APIs to docs folder (#31118)
2018-09-01 07:49:24 +08:00
include::defs.asciidoc[]