Docs
  • Release notes
  • Troubleshoot
  • Reference
  1. Docs /
  2. Reference /
  3. Cloud /
  4. Elastic Cloud Enterprise /
  5. 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
  • View as Markdown
  • Report a docs issue
  • Edit this page
  • Learn how to contribute
Get started free
  • 14-day free trial
  • All features included
  • No setup required
  • Elastic fundamentals
  • Solutions and use cases
  • Manage data
  • Explore and analyze
  • Deploy and manage
  • Manage your Cloud account
  • Troubleshoot
  • Release notes
  • Reference
  • Extend and contribute
  • Contribute to the docs
  • Elasticsearch
    • Configuration
      • Circuit breaker settings
      • Auditing settings
      • Enrich settings
      • Cluster-level shard allocation and routing settings
      • Miscellaneous cluster settings
      • Cross-cluster replication settings
      • Discovery and cluster formation settings
      • Field data cache settings
      • Health Diagnostic settings
      • Index lifecycle management settings
      • Data stream lifecycle settings
      • Index management settings
      • Index recovery settings
      • Indexing buffer settings
      • Indexing pressure
      • Ingest settings
      • License settings
      • Local gateway
      • Machine learning settings
      • Inference settings
      • Monitoring settings
      • Node settings
      • Path settings
      • Networking settings
      • Node query cache settings
      • Remote cluster settings
      • Search settings
      • Security settings
      • Cluster state encryption
      • Shard request cache
      • Snapshot and restore settings
        • S3 repository
        • Azure repository
        • GCS repository
        • Shared file system repository
        • Read-only URL repository
        • Source-only repository
      • Transforms settings
      • Thread pool settings
      • Watcher settings
    • JVM settings
    • Built-in roles
    • Elasticsearch privileges
    • Columnar
    • Index settings
      • Serverless index settings
      • General
      • Shard allocation
        • Data tier allocation
        • Index recovery prioritization
        • Total shards per node
      • History retention
      • Index blocks
      • Mapping limit
      • Merge
      • Similarity
      • Slow log
      • Sorting
        • Use index sorting to speed up conjunctions
      • Store
        • Preloading data into the file system cache
      • Time series
      • Source settings
      • Translog
    • Index lifecycle actions
      • Allocate
      • Delete
      • Force merge
      • Migrate
      • Read only
      • Rollover
      • Downsample
      • Searchable snapshot
      • Set priority
      • Shrink
      • Unfollow
      • Wait for snapshot
    • REST APIs
      • API conventions
      • Common options
      • Compatibility
      • Guides and examples
        • Collapse search results
        • Create index from source
        • Understand the lifecycle status
        • Filter search results
        • Rescore search results
        • Find text structure API examples
        • Highlighting
          • Highlighting settings
          • Highlighting examples
          • How highlighters work internally
        • Analyze index disk usage
        • Optimistic concurrency control
        • Paginate search results
        • Query API key information
        • Reciprocal rank fusion
        • The refresh parameter
        • Reindex data stream
        • Reindex indices
        • Retrieve inner hits
        • Retrieve selected fields
        • Retrieve stored fields
        • Retrievers
          • kNN retriever
          • Linear retriever
          • Pinned retriever
          • Rescorer retriever
          • RRF retriever
          • Query rules retriever
          • Standard retriever
          • Text similarity re-ranker retriever
          • Diversify retriever
          • Examples
        • Search multiple data streams and indices
        • Profile search requests
        • Ranking evaluation
        • Search shard routing
        • Suggesters
        • Sort search results
        • Searching with query rules
        • The shard request cache
        • Term vectors API examples
        • Update By Query API
        • Update a document
        • Update cross-cluster API examples
        • Vector tile search API
    • Mapping
      • Document metadata fields
        • _doc_count field
        • _field_names field
        • _ignored field