cloud
elastic/cloud master f075087
Cloud
  • Cloud
    • Elastic Cloud Enterprise
      • RESTful API
        • API calls
        • How to access the API
          • Access the API using Elastic Cloud Control
          • Access the API from the command line
          • Access the API using a REST application
          • Access the API using the Elastic Cloud Terraform provider
          • Create an API client
        • API examples
          • Setting up your environment
          • A first API call: What deployments are there?
          • Create your first deployment: Elasticsearch and Kibana
          • Applying a new plan: Resize and add high availability
          • Updating a deployment: Checking on progress
          • Applying a new deployment configuration: Upgrade
          • Enable more stack features: Add Enterprise Search to a deployment
          • Dipping a toe into platform automation: Generate a roles token
          • Customize your deployment
          • Remove unwanted deployment templates and instance configurations
          • Secure your settings
        • Changes to index allocation and API
      • Scripts
        • elastic-cloud-enterprise.sh install
        • elastic-cloud-enterprise.sh upgrade
        • elastic-cloud-enterprise.sh reset-adminconsole-password
        • elastic-cloud-enterprise.sh add-stack-version
      • Third party dependencies
        • ECE 4.0
    • Elastic Cloud Hosted
      • Hardware
        • GCP instance
          • VM configurations
          • Selecting the right configuration for you
        • GCP default provider
          • Regional availability
        • AWS
          • VM configurations
          • VM configurations (FedRAMP Moderate Authorized)
          • Selecting the right configuration for you
        • AWS default
          • Regional availability
        • Azure
          • VM configurations
          • Selecting the right configuration for you
        • Azure default
          • Regional availability
      • Regions
        • Available regions, deployment templates, and instance configurations
      • RESTful API
        • Principles
        • Rate limiting
        • Work with Elastic APIs
          • Access the Elasticsearch API console
        • How to access the API
          • Access the API using Elastic Cloud Control
          • Access the API from the command line
          • Access the API using a REST application
          • Access the API using the Elastic Cloud Terraform provider
        • API examples
          • Deployment CRUD operations
          • Other deployment operations
          • Organization operations
        • Changes to index allocation and API
  • Cloud release notes
    • Elastic Cloud Enterprise
      • Known issues
      • Breaking changes
      • Deprecations
    • Elastic Cloud Hosted
      • Known issues
      • Breaking changes
      • Deprecations
  • View as Markdown
  • Report a docs issue
  • Edit this page
  • Learn how to contribute
Loading
  1. Elastic Cloud Enterprise /
  2. RESTful API

ECE API examples

Note

This documentation applies to the Elastic Cloud Enterprise API only. If you are using Elasticsearch Service, check the Elastic Cloud API information instead.

Learn how to use the Elastic Cloud Enterprise RESTful API by example. Check our setup instructions, and then you’re ready to try out these examples:

  • A first API call: What deployments are there?
  • Create a first deployment: Elasticsearch and Kibana
  • Applying a new plan: Resize and add high availability
  • Updating a deployment: Check on progress
  • Applying a new deployment configuration: Upgrade
  • Dipping a toe into platform automation: Generate a roles token
  • Customize your deployment
  • Remove unwanted deployment templates and instance configurations
  • Secure your settings

You can find additional RESTful API examples in:

  • Configure deployment templates
  • Generate roles tokens
  • Manage Elastic Stack versions
  • Manage security certificates
  • Create an autoscaled deployment
  • Enable cross-cluster search
  • Manage network security through the API
  • Enable Integrations Server through the API
  • Switch from APM to Integrations Server payload

A complete list of available API operations and request/response models are available in the API reference documentation.

Previous
Create an API client
Next
Setting up your environment
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.