APIs
  • Elasticsearch Serverless API
    Back to hub Cloud Billing API Elastic Cloud API Elastic Cloud Connected API Elastic Cloud Enterprise API Elastic Cloud Serverless API Elasticsearch API Elasticsearch Serverless API Kibana APIs Kibana Serverless APIs Logstash APIs
  • Download source
    JSON YAML
  1. APIs /
  2. Elasticsearch Serverless API

Licensing

View as Markdown

Licensing APIs enable you to manage your licenses.

For more information about the different types of licenses, refer to Elastic subscriptions.

1 endpoint

  • Get license information
    • GET /_license
  • Authentication
  • Behavioral analytics
    • Get behavioral analytics collections GET
    • Create a behavioral analytics collection PUT
    • Delete a behavioral analytics collection DELETE
  • Cluster
    • Get cluster info GET
    • Ping the cluster HEAD
  • 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
  • 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
    • Reindex documents POST
    • Get multiple documents POST
    • Get multiple term vectors POST
    • Throttle a reindex operation 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 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 an ES|QL view GET
    • Create or update an ES|QL view PUT
    • Delete an ES|QL view DELETE
    • Get a specific running ES|QL query information GET
    • Get running ES|QL queries information GET
    • Run an ES|QL query 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
    • Check index templates HEAD
    • Get aliases GET
    • Check aliases HEAD
    • Get mapping definitions GET
    • Update field mappings POST
    • Get index settings GET
    • Update index settings PUT
    • Refresh an index GET
    • Resolve indices POST
    • Roll over to a new index POST
    • Simulate an index POST
    • Simulate an index template POST
    • Create or update an alias POST
    • Validate a query POST
  • Inference
    • Perform streaming chat completion inference on the service POST
    • Perform completion inference on the service POST
    • Get an inference endpoint GET
    • Create an inference endpoint PUT
    • Perform inference on the service POST
    • Delete an inference endpoint DELETE
    • Get the inference region policy GET
    • Create or update the inference region policy PUT
    • Delete the inference region policy DELETE
    • Perform dense embedding inference on the service POST
    • Perform non-streaming chat completion 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 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
    • 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
    • Perform reranking inference on the service POST
    • Perform sparse embedding inference on the service POST
    • Perform streaming completion inference on the service POST
    • Perform text embedding inference on the service POST
    • Update an inference endpoint PUT
  • Info
    • Get cluster info GET
  • Ingest
    • Get pipelines GET
    • Create or update a pipeline PUT
    • Delete pipelines DELETE
    • Run a grok processor GET
    • Simulate a pipeline 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
    • Close anomaly detection jobs POST
    • Create a calendar PUT
    • Get calendar configuration info POST
    • Delete a calendar DELETE
    • 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
    • Get filters GET
    • Create a filter PUT
    • Delete a filter DELETE
    • Get anomaly detection jobs configuration info GET
    • Create an anomaly detection job PUT
    • Delete an anomaly detection job DELETE
    • Estimate job model memory usage POST
    • Force buffered data to be processed POST
    • Predict future behavior of a time series POST
    • Get info about events in calendars GET
    • Add scheduled events to the calendar POST
    • Get datafeed stats GET
    • Get anomaly detection job stats GET
    • Get overall bucket results POST
    • Open anomaly detection jobs POST
    • Preview a datafeed POST
    • Reset an anomaly detection job POST
    • Start datafeeds POST
    • Stop datafeeds POST
    • Update a datafeed POST
    • Update a filter POST
    • Update an anomaly detection job POST
  • Machine learning data frame analytics
    • Get data frame analytics job configuration info GET
    • Create a data frame analytics job PUT
    • Delete a data frame analytics job DELETE
    • Evaluate data frame analytics POST
    • Get data frame analytics job stats GET
    • Preview features used by data frame analytics POST
    • Start a data frame analytics job POST
    • 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
    • Create or update a trained model alias PUT
    • Delete a trained model alias DELETE
    • Get trained models usage info GET
    • Evaluate a trained model POST
    • Create part of a trained model definition PUT
    • Create a trained model vocabulary PUT
    • Start a trained model deployment POST
    • Stop a trained model deployment POST
    • Update a trained model deployment POST
  • Migration
    • Cancel a migration reindex operation POST
    • Create an index from a source index POST
    • Get the migration reindexing status GET
  • Project
    • 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
    • Get tags POST
  • Query rules
    • Get a query rule GET
    • Create or update a query rule PUT
    • Delete a query rule DELETE
    • Get a query ruleset GET
    • Create or update a query ruleset PUT
    • Delete a query ruleset DELETE
    • Get all query rulesets GET
    • Test a query ruleset POST
  • Reindex
    • Cancel an ongoing reindex task POST
    • Get the status and progress of a specific reindex task GET
    • Get information about all currently running reindex tasks GET
  • Script
    • Get a script or search template GET
    • Delete a script or search template DELETE
    • Create or update a script or search template POST
    • Run a script POST
  • Search
    • Get async search results GET
    • Delete an async search DELETE
    • Get the async search status GET
    • Run an async search POST
    • Run a scrolling search POST
    • Clear a scrolling search DELETE
    • Close a point in time DELETE
    • Count search results GET
    • Explain a document match result POST
    • Get the field capabilities POST
    • Run multiple searches POST
    • Run multiple templated searches POST
    • Open a point in time POST
    • Evaluate ranked search results POST
    • Render a search template POST
    • Run a search POST
    • Search a vector tile GET
    • Run a search with a search template POST
    • Get terms in an index POST
  • Search application
    • Get search application details GET
    • Create or update a search application PUT
    • Delete a search application DELETE
    • Get search applications GET
    • Run a search application search POST
  • Security
    • Authenticate a user GET
    • Get API key information GET
    • Create an API key POST
    • Invalidate API keys DELETE
    • Create a service account token POST
    • Delete service account tokens DELETE
    • Get roles GET
    • Create or update roles POST
    • Delete roles DELETE
    • Get builtin privileges GET
    • Check user privileges POST
    • Find API keys with a query POST
    • Find roles with a query POST
    • Update an API key PUT
  • SQL
    • Clear an SQL search cursor POST
    • Delete an async SQL search DELETE
    • Get async SQL search results GET
    • Get the async SQL search status GET
    • Get SQL search results GET
    • Translate SQL into Elasticsearch queries GET
  • Synonyms
    • 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
    • Get all synonym sets GET
  • Task management
    • Get task information GET
  • Transform
    • Get transforms GET
    • Create a transform PUT
    • Delete a transform DELETE
    • Get node stats GET
    • Get transform stats GET
    • Preview a transform POST
    • Reset a transform POST
    • Schedule a transform to start now POST
    • Start a transform POST
    • Stop transforms POST
    • Update a transform POST
  • Types
    • Query DSL
      • QueryContainer
    • Aggregations
      • AggregationContainer
      • Aggregate
    • Ingest
      • ProcessorContainer
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