1. Docs /
  2. APIs /
  3. Elasticsearch Serverless API

Licensing

Licensing APIs enable you to manage your licenses.

  • Get license information
    • GET /_license
View as Markdown
Download OpenAPI spec (JSON) Download OpenAPI spec (YAML)
Learn more
For more information about the different types of licenses, refer to Elastic subscriptions.
Elastic Stack
Elasticsearch API Elasticsearch Serverless API Kibana API Kibana Serverless API Logstash API
Orchestration
Elastic Cloud API Cloud Billing API Elastic Cloud Connected API Elastic Cloud Enterprise API Elastic Cloud Serverless API
All APIs
  • Topics
    • Authentication

  • Behavioral analytics
    • Create a behavioral analytics collection event Deprecated POST
    • Get behavioral analytics collections Deprecated GET
    • Create a behavioral analytics collection Deprecated PUT
    • Delete a behavioral analytics collection Deprecated DELETE
  • Cluster
    • Ping the cluster HEAD
    • Get cluster subsystem info GET
  • Compact and aligned text (CAT)
    • Get CAT help GET
    • Get a compact list of aliases GET
    • Get a compact list of component templates GET
    • Get a document count POST
    • Get a compact list of indices GET
    • Get anomaly detection jobs GET
    • Get data frame analytics jobs GET
    • Get datafeeds GET
    • Get trained models GET
    • Get transform information GET
  • Connector
    • Get all connectors GET
    • Create a connector POST
    • Get all connector sync jobs GET
    • Create a connector sync job POST
    • Get a connector sync job GET
    • Delete a connector sync job DELETE
    • Cancel a connector sync job PUT
    • Check in a connector sync job PUT
    • Claim a connector sync job PUT
    • Set a connector sync job error PUT
    • Set the connector sync job stats PUT
    • Get a connector GET
    • Create or update a connector PUT
    • Delete a connector DELETE
    • Update the connector API key ID PUT
    • Check in a connector PUT
    • Update the connector configuration PUT
    • Update the connector error field PUT
    • Update the connector features PUT
    • Update the connector filtering PUT
    • Activate the connector draft filter 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
    • Convert an index alias to a data stream POST
    • Update data streams POST
    • Get data streams GET
    • Create a data stream PUT
    • Delete data streams DELETE
    • 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
    • Get data stream lifecycle stats GET
    • Get the status for a data stream lifecycle GET
  • Document
    • Reindex documents POST
    • Throttle a reindex operation POST
    • Bulk index or delete documents POST
    • Create a new document in the index POST
    • Delete documents 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
    • Get multiple documents POST
    • Get multiple term vectors POST
    • Get a document's source GET
    • Check for a document source HEAD
    • 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 the async EQL status GET
    • Get async EQL search results GET
    • Delete an async EQL search DELETE
    • Get EQL search results POST
  • ES|QL
    • Run an ES|QL query POST
    • Run an async ES|QL query POST
    • Get async ES|QL query results GET
    • Delete an async ES|QL query DELETE
    • Stop async ES|QL query POST
    • Get ES|QL data sources GET
    • Create or update an ES|QL data source PUT
    • Delete ES|QL data sources DELETE
    • Get ES|QL datasets GET
    • Create or update an ES|QL dataset PUT
    • Delete ES|QL datasets DELETE
    • Get running ES|QL queries information GET
    • Get a specific running ES|QL query information GET
    • Get an ES|QL view GET
    • Create or update an ES|QL view PUT
    • Delete an ES|QL view DELETE
  • Index
    • Update aliases and delete indices atomically POST
    • Get component templates GET
    • Create or update a component template POST
    • Delete component templates DELETE
    • Check component templates HEAD
    • Simulate an index template POST
    • Simulate an index POST
    • Get index templates GET
    • Create or update an index template POST
    • Delete an index template DELETE
    • Check index templates HEAD
    • Resolve indices POST
    • Roll over to a new index POST
    • Get index information GET
    • Create an index PUT
    • Delete indices DELETE
    • Check indices HEAD
    • Get aliases GET
    • Check aliases HEAD
    • Create or update an alias POST
    • Delete an alias DELETE
    • Get tokens from text analysis POST
    • Add an index block PUT
    • Remove an index block DELETE
    • Get mapping definitions GET
    • Update field mappings POST
    • Refresh an index POST
    • Update index settings PUT
    • Get index settings GET
    • Validate a query POST
  • Inference
    • Get the inference region policy GET
    • Create or update the inference region policy PUT
    • Delete the inference region policy DELETE
    • Perform non-streaming chat completion inference on the service POST
    • Perform streaming chat completion inference on the service POST
    • Perform completion inference on the service POST
    • Perform streaming completion inference on the service POST
    • Perform decision inference on the service POST
    • Perform document extraction inference on the service POST
    • Perform dense embedding inference on the service POST
    • Perform reranking inference on the service POST
    • Perform sparse embedding inference on the service POST
    • Perform text embedding inference on the service POST
    • Create a AI21 inference endpoint PUT
    • Create an AlibabaCloud AI Search inference endpoint PUT
    • Create an Amazon Bedrock inference endpoint PUT
    • Create an Amazon SageMaker inference endpoint PUT
    • Create an Anthropic inference endpoint PUT
    • Create an Azure AI studio inference endpoint PUT
    • Create an Azure OpenAI inference endpoint PUT
    • Create a Cohere inference endpoint PUT
    • Create an Contextual AI inference endpoint PUT
    • Create a custom inference endpoint PUT
    • Create a DeepSeek inference endpoint PUT
    • Create an Elasticsearch inference endpoint PUT
    • Create an ELSER inference endpoint Deprecated PUT
    • Create a Fireworks AI inference endpoint PUT
    • Create an Google AI Studio inference endpoint PUT
    • Create a Google Vertex AI inference endpoint PUT
    • Create a Groq inference endpoint PUT
    • Create a Hugging Face inference endpoint PUT
    • Get an inference endpoint GET
    • Perform inference on the service POST
    • Create an inference endpoint PUT
    • Delete an inference endpoint DELETE
    • Update an inference endpoint PUT
    • Create an JinaAI inference endpoint PUT
    • Create a Llama inference endpoint PUT
    • Create a Mistral inference endpoint PUT
    • Create an Nvidia inference endpoint PUT
    • Create an OpenAI inference endpoint PUT
    • Create an OpenShift AI inference endpoint PUT
    • Create a VoyageAI inference endpoint PUT
    • Create a Watsonx inference endpoint PUT
  • Info
    • Get cluster info GET
  • Ingest
    • Get pipelines GET
    • Create or update a pipeline PUT
    • Delete pipelines DELETE
    • Simulate a pipeline POST
    • Run a grok processor GET
    • Simulate data ingestion POST
  • Licensing
    • Get license information GET
  • Logstash
    • Get Logstash pipelines GET
    • Create or update a Logstash pipeline PUT
    • Delete a Logstash pipeline DELETE
  • Machine learning anomaly detection
    • Estimate job model memory usage POST
    • Get anomaly detection jobs configuration info GET
    • Create an anomaly detection job PUT
    • Delete an anomaly detection job DELETE
    • Close anomaly detection jobs POST
    • Force buffered data to be processed Deprecated POST
    • Predict future behavior of a time series POST
    • Open anomaly detection jobs POST
    • Reset an anomaly detection job POST
    • Get anomaly detection job stats GET
    • Update an anomaly detection job POST
    • Get overall bucket results POST
    • Get calendar configuration info POST
    • Create a calendar PUT
    • Delete a calendar DELETE
    • Get info about events in calendars GET
    • Add scheduled events to the calendar POST
    • Delete events from a calendar DELETE
    • Add anomaly detection job to calendar PUT
    • Delete anomaly jobs from a calendar DELETE
    • Get datafeeds configuration info GET
    • Create a datafeed PUT
    • Delete a datafeed DELETE
    • Preview a datafeed POST
    • Start datafeeds POST
    • Get datafeed stats GET
    • Stop datafeeds POST
    • Update a datafeed POST
    • Get filters GET
    • Create a filter PUT
    • Delete a filter DELETE
    • Update a filter POST
  • Machine learning data frame analytics
    • Evaluate data frame analytics POST
    • Get data frame analytics job configuration info GET
    • Create a data frame analytics job PUT
    • Delete a data frame analytics job DELETE
    • Preview features used by data frame analytics POST
    • Start a data frame analytics job POST
    • Get data frame analytics job stats GET
    • Stop data frame analytics jobs POST
    • Update a data frame analytics job POST
  • Machine learning trained model
    • Get trained model configuration info GET
    • Create a trained model PUT
    • Delete an unreferenced trained model DELETE
    • Evaluate a trained model POST
    • Get trained models usage info GET
    • Create part of a trained model definition PUT
    • Start a trained model deployment POST
    • Stop a trained model deployment POST
    • Update a trained model deployment POST
    • Create or update a trained model alias PUT
    • Delete a trained model alias DELETE
    • Create a trained model vocabulary PUT
  • Migration
    • Create an index from a source index POST
    • Cancel a migration reindex operation POST
    • Get the migration reindexing status GET
  • Project
    • Get tags POST
    • Get project routing expressions GET
    • Create or update project routing expressions PUT
    • Get a project routing expression GET
    • Create or update a project routing expression PUT
    • Delete a project routing expression DELETE
  • Query rules
    • Get all query rulesets GET
    • Get a query ruleset GET
    • Create or update a query ruleset PUT
    • Delete a query ruleset DELETE
    • Get a query rule GET
    • Create or update a query rule PUT
    • Delete a query rule DELETE
    • Test a query ruleset POST
  • Reindex
    • Get information about all currently running reindex tasks GET
    • Get the status and progress of a specific reindex task GET
    • Cancel an ongoing reindex task POST
  • Script
    • Run a script POST
    • Get a script or search template GET
    • Delete a script or search template DELETE
    • Create or update a script or search template POST
  • Search
    • Get the async search status GET
    • Get async search results GET
    • Delete an async search DELETE
    • Close a point in time DELETE
    • Render a search template POST
    • Run a scrolling search POST
    • Clear a scrolling search DELETE
    • Run an async search POST
    • Count search results POST
    • Explain a document match result POST
    • Get the field capabilities POST
    • Evaluate kNN search settings POST
    • Run multiple searches POST
    • Run multiple templated searches POST
    • Search a vector tile POST
    • Open a point in time POST
    • Evaluate ranked search results POST
    • Run a search POST
    • Run a search with a search template POST
    • Get terms in an index POST
  • Search application
    • Get search applications GET
    • Get search application details GET
    • Create or update a search application PUT
    • Delete a search application DELETE
    • Run a search application search POST
  • Security
    • Authenticate a user GET
    • Find API keys with a query POST
    • Find roles with a query POST
    • Get API key information GET
    • Create an API key POST
    • Invalidate API keys DELETE
    • Bulk update API keys POST
    • Update an API key PUT
    • Get builtin privileges GET
    • Get roles GET
    • Create or update roles POST
    • Delete roles DELETE
    • Create a service account token POST
    • Delete service account tokens DELETE
    • Check user privileges POST
  • SQL
    • Get SQL search results POST
    • Delete an async SQL search DELETE
    • Get the async SQL search status GET
    • Get async SQL search results GET
    • Clear an SQL search cursor POST
    • Translate SQL into Elasticsearch queries POST
  • Streams
    • Get the status of streams GET
    • Disable a named stream POST
    • Enable a named stream POST
  • Synonyms
    • Get all synonym sets GET
    • Get a synonym set GET
    • Create or update a synonym set PUT
    • Delete a synonym set DELETE
    • Get a synonym rule GET
    • Create or update a synonym rule PUT
    • Delete a synonym rule DELETE
  • Task management
    • Get task information GET
  • Transform
    • Get node stats GET
    • Get transforms GET
    • Create a transform PUT
    • Delete a transform DELETE
    • Preview a transform POST
    • Reset a transform POST
    • Schedule a transform to start now POST
    • Start a transform POST
    • Get transform stats GET
    • Stop transforms POST
    • Update a transform POST

  • Types
    • Query DSL
      • Query
    • Aggregations
      • Aggregation
      • Aggregation result
    • Ingest
      • Processor
Elastic logo
  • Trademarks
  • Terms of Use
  • Privacy
  • Sitemap

© 2026 Elasticsearch B.V. All Rights Reserved.

This content is available in different formats for convenience only. All original licensing terms apply.

Elasticsearch is a trademark of Elasticsearch B.V., registered in the U.S. and in other countries. Apache, Apache Lucene, Apache Hadoop, Hadoop, HDFS and the yellow elephant logo are trademarks of the Apache Software Foundation in the United States and/or other countries.

Notice at Collection | Your Privacy Choices