A newer version is available. For the latest information, see the
current release documentation.
API examples
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
API examples
editThis 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
- 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
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 traffic filters 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.