API reference | Starting with the Elasticsearch Platform and its Solutions [8.16]

<!DOCTYPE html> <html lang="en-us"> <head> <meta charset="UTF-8"> <title>API reference | Starting with the Elasticsearch Platform and its Solutions [8.16] | Elastic</title> <meta class="elastic" name="content" content="API reference | Starting with the Elasticsearch Platform and its Solutions [8.16]"> <link rel="home" href="index.html" title="Starting with the Elasticsearch Platform and its Solutions [8.16]"/> <link rel="up" href="index.html" title="Starting with the Elasticsearch Platform and its Solutions [8.16]"/> <link rel="prev" href="index.html" title="Starting with the Elasticsearch Platform and its Solutions [8.16]"/> <link rel="next" href="new.html" title="Release docs"/> <meta class="elastic" name="product_version" content="8.16"/> <meta class="elastic" name="product_name" content="Starting with the Elasticsearch Platform and its Solutions"/> <meta class="elastic" name="website_area" content="documentation"/> <meta name="DC.type" content="Learn/Docs/Elastic/Starting with the Elasticsearch Platform and its Solutions/8.16"/> <meta name="DC.subject" content="Starting with the Elasticsearch Platform and its Solutions"/> <meta name="DC.identifier" content="8.16"/> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <script src="https://cdn.optimizely.com/js/18132920325.js"></script> <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png"> <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png"> <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png"> <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png"> <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png"> <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png"> <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png"> <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png"> <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png"> <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32"> <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192"> <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96"> <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16"> <link rel="manifest" href="/manifest.json"> <meta name="apple-mobile-web-app-title" content="Elastic"> <meta name="application-name" content="Elastic"> <meta name="msapplication-TileColor" content="#ffffff"> <meta name="msapplication-TileImage" content="/mstile-144x144.png"> <meta name="theme-color" content="#ffffff"> <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd" /> <meta name="yandex-verification" content="d8a47e95d0972434" /> <meta name="localized" content="true" /> <meta name="st:robots" content="follow,index" /> <meta property="og:image" content="https://static-www.elastic.co/v3/assets/bltefdd0b53724fa2ce/blt280217a63b82a734/6202d3378b1f312528798412/elastic-logo.svg" /> <meta property="og:image:width" content="500" /> <meta property="og:image:height" content="172" /> <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon"> <link rel="icon" href="/favicon.ico" type="image/x-icon"> <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png"> <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png"> <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">   <link rel="stylesheet" type="text/css" href="/guide/static/styles-v1.css" /> </head>    <body>  <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>   <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-12395217-16'); </script>  <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KNJMG2M');</script> <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KNJMG2M" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>  <div id='elastic-nav' style="display:none;"></div> <script src='https://www.elastic.co/elastic-nav.js'></script> <div class="main-container"> <section id="content" > <div class="content-wrapper"> <section id="guide" lang="en"> <div class="container-fluid"> <div class="row pb-3"> <div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">  </div> <div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">  <div class="navheader"> <span class="prev"> </span> <span class="next"> <a href="new.html">Release docs »</a> </span> </div> <div class="book" lang="en"> <div class="titlepage"> <div class="breadcrumbs"> <span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span> <span class="chevron-right">›</span><span class="breadcrumb-link"><a href="index.html">Starting with the Elasticsearch Platform and its Solutions [8.16]</a></span> </div> <div> <div><h1 class="title"><a id="id-1"></a>API reference</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/tech-content/edit/8.16/welcome-to-elastic/api-reference.asciidoc">edit</a></div> </div>  </div> <div id="content"> <div class="chapter"> <div class="titlepage"><div><div> <div class="position-relative"><h2 class="title"><a id="api-reference"></a>API reference</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/tech-content/edit/8.16/welcome-to-elastic/api-reference.asciidoc">edit</a></div> </div></div></div> <p>Explore the reference documentation for Elastic APIs.</p> <div class="informaltable"> <table border="1" cellpadding="4px"> <colgroup> <col class="col_1"/> <col class="col_2"/> </colgroup> <tbody> <tr> <td align="left" valign="top"><p>Elasticsearch</p></td> <td align="left" valign="top"> <div class="ulist itemizedlist"> <ul class="itemizedlist"> <li class="listitem"> <a href="/guide/en/elasticsearch/reference/8.16/rest-apis.html" class="ulink" target="_top">Elasticsearch</a> </li> <li class="listitem"> <a href="/docs/api/doc/elasticsearch-serverless" class="ulink" target="_top">Elasticsearch Serverless</a> </li> </ul> </div> </td> </tr> <tr> <td align="left" valign="top"><p>Kibana</p></td> <td align="left" valign="top"> <div class="ulist itemizedlist"> <ul class="itemizedlist"> <li class="listitem"> <a href="/guide/en/kibana/8.16/api.html" class="ulink" target="_top">Kibana</a> </li> <li class="listitem"> <a href="/guide/en/fleet/8.16/fleet-api-docs.html" class="ulink" target="_top">Fleet</a> </li> <li class="listitem"> <a href="/docs/api/doc/serverless/operation/operation-createconnector" class="ulink" target="_top">Serverless management settings</a> </li> <li class="listitem"> <a href="/docs/api/doc/serverless/operation/operation-createsloop" class="ulink" target="_top">Observability Serverless SLOs</a> </li> <li class="listitem"> <a href="/guide/en/security/8.16/security-apis.html" class="ulink" target="_top">Elastic Security</a> </li> <li class="listitem"> <a href="/docs/api/" class="ulink" target="_top">Elastic Security Serverless</a> </li> </ul> </div> </td> </tr> <tr> <td align="left" valign="top"><p>Logstash</p></td> <td align="left" valign="top"> <div class="ulist itemizedlist"> <ul class="itemizedlist"> <li class="listitem"> <a href="/guide/en/logstash/8.16/monitoring-logstash.html" class="ulink" target="_top">Monitoring Logstash</a> </li> </ul> </div> </td> </tr> <tr> <td align="left" valign="top"><p>APM</p></td> <td align="left" valign="top"> <div class="ulist itemizedlist"> <ul class="itemizedlist"> <li class="listitem"> <a href="/guide/en/apm/guide/8.16/api.html" class="ulink" target="_top">APM</a> </li> <li class="listitem"> <a href="/docs/api/doc/serverless/operation/operation-createagentkey" class="ulink" target="_top">APM Serverless</a> </li> <li class="listitem"> <a href="https://docs.elastic.co/serverless/observability/apm-server-api" class="ulink" target="_top">APM Serverless managed intake service event</a> </li> </ul> </div> </td> </tr> <tr> <td align="left" valign="top"><p>Elastic Cloud</p></td> <td align="left" valign="top"> <div class="ulist itemizedlist"> <ul class="itemizedlist"> <li class="listitem"> <a href="/guide/en/cloud/current/ec-restful-api.html" class="ulink" target="_top">Elasticsearch Service</a> </li> <li class="listitem"> <a href="/docs/api/doc/elastic-cloud-serverless" class="ulink" target="_top">Elastic Cloud Serverless</a> </li> <li class="listitem"> <a href="/guide/en/cloud-enterprise/current/ece-restful-api.html" class="ulink" target="_top">Elastic Cloud Enterprise</a> </li> <li class="listitem"> <a href="/guide/en/cloud-on-k8s/current/k8s-api-reference.html" class="ulink" target="_top">Elastic Cloud on Kubernetes</a> </li> </ul> </div> </td> </tr> </tbody> </table> </div> </div> </div> </div><div class="navfooter"> <span class="prev"> </span> <span class="next"> <a href="new.html">Release docs »</a> </span> </div>  </div> <div class="col-12 order-3 col-lg-2 order-lg-3 h-almost-full-lg sticky-top-lg" id="right_col"> <div id="sticky_content">  <div class="row"> <div class="col-0 col-md-4 col-lg-0" id="bottom_left_col"></div> <div class="col-12 col-md-8 col-lg-12"> <div id="rtpcontainer"> <div class="mktg-promo" id="most-popular"> <p class="aside-heading">Most Popular</p> <div class="pb-2"> <p class="media-type">Video</p> <a href="https://www.elastic.co/webinars/getting-started-elasticsearch?page=docs&placement=top-video"> <p class="mb-0">Get Started with Elasticsearch</p> </a> </div> <div class="pb-2"> <p class="media-type">Video</p> <a href="https://www.elastic.co/webinars/getting-started-kibana?page=docs&placement=top-video"> <p class="mb-0">Intro to Kibana</p> </a> </div> <div class="pb-2"> <p class="media-type">Video</p> <a href="https://www.elastic.co/webinars/introduction-elk-stack?page=docs&placement=top-video"> <p class="mb-0">ELK for Logs & Metrics</p> </a> </div> </div> </div>  <div id="feedbackWidgetContainer"></div> </div> </div> </div> </div> </div> </div> </section> </div> <div id='elastic-footer'></div> <script src='https://www.elastic.co/elastic-footer.js'></script>  </section> </div>  <div id="feedbackModalContainer"></div> <script src="/guide/static/jquery.js"></script> <script type="text/javascript" src="/guide/static/docs-v1.js"></script> <script type="text/javascript"> window.initial_state = {}</script> </body> </html>

CINXE.COM

API reference | Starting with the Elasticsearch Platform and its Solutions [8.16] | Elastic