Elastic APIs hub
  • Elastic Cloud API
  • Elastic Cloud Billing API
  • Elastic Cloud Enterprise API
  • Elastic Cloud Serverless API
  • Elasticsearch API
  • Elasticsearch Serverless API
  • Kibana API
  • Kibana Serverless API
  • Logstash API
  • Observability Intake Serverless API
Back to hub page
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Feedback
Elasticsearch Serverless API logo

Topics

  • Introduction
  • Authentication

Endpoints

  • Behavioral analytics
    • Get behavioral analytics collections GET
    • Create a behavioral analytics collection PUT
    • Delete a behavioral analytics collection DELETE
  • Compact and aligned text (CAT)
    • Get aliases GET
    • Get component templates GET
    • Get a document count GET
    • Get CAT help GET
    • Get index information GET
    • Get data frame analytics jobs GET
    • Get datafeeds GET
    • Get anomaly detection jobs GET
    • Get trained models GET
    • Get transform information GET
  • Cluster
    • Get cluster info GET
    • Ping the cluster HEAD
  • Connector
    • Check in a connector PUT
    • Get a connector GET
    • Create or update a connector PUT
    • Delete a connector DELETE
    • Get all connectors GET
    • Create a connector POST
    • Cancel a connector sync job PUT
    • Get a connector sync job GET
    • Delete a connector sync job DELETE
    • Get all connector sync jobs GET
    • Create a connector sync job POST
    • Activate the connector draft filter PUT
    • Update the connector API key ID PUT
    • Update the connector configuration PUT
    • Update the connector error field PUT
    • Update the connector filtering PUT
    • Update the connector draft filtering validation PUT
    • Update the connector index name PUT
    • Update the connector name and description PUT
    • Update the connector is_native flag PUT
    • Update the connector pipeline PUT
    • Update the connector scheduling PUT
    • Update the connector service type PUT
    • Update the connector status PUT
  • Data stream
    • Get data streams GET
    • Create a data stream PUT
    • Delete data streams DELETE
    • Get the status for a data stream lifecycle GET
    • Get data stream lifecycles GET
    • Update data stream lifecycles PUT
    • Get data stream mappings GET
    • Update data stream mappings PUT
    • Get data stream options GET
    • Update data stream options PUT
    • Get data stream settings GET
    • Update data stream settings PUT
    • Convert an index alias to a data stream POST
    • Update data streams POST
  • Document
    • Bulk index or delete documents PUT
    • Create a new document in the index POST
    • Get a document by its ID GET
    • Create or update a document in an index POST
    • Delete a document DELETE
    • Check a document HEAD
    • Delete documents POST
    • Get a document's source GET
    • Check for a document source HEAD
    • Get multiple documents POST
    • Get multiple term vectors POST
    • Reindex documents POST
    • Get term vector information POST
    • Update a document POST
    • Update documents POST
  • Enrich
    • Get an enrich policy GET
    • Create an enrich policy PUT
    • Delete an enrich policy DELETE
    • Run an enrich policy PUT
  • EQL
    • Get async EQL search results GET
    • Delete an async EQL search DELETE
    • Get the async EQL status GET
    • Get EQL search results POST
  • ES|QL
    • Get a specific running ES|QL query information GET
    • Get running ES|QL queries information GET
    • Run an ES|QL query POST
  • Graph explore
    • Explore graph analytics POST
  • Index
    • Get component templates GET
    • Create or update a component template POST
    • Delete component templates DELETE
    • Check component templates HEAD
    • Add an index block PUT
    • Remove an index block DELETE
    • Get tokens from text analysis POST
    • Get index information GET
    • Create an index PUT
    • Delete indices DELETE
    • Check indices HEAD
    • Create or update an alias POST
    • Delete an alias DELETE
    • Get index templates GET
    • Create or update an index template POST
    • Delete an index template DELETE