Elasticsearch API Documentation

Elastic Cloud API

Number of APIs: 72

GET {{baseUrl}}/stack/versions?show_deleted=false&show_unusable=false

By default, retrieves only the available Elastic Stack versions. To retrieve all of the Elastic Stack versions, use the show_deleted parameter.

2. deployments-{deployment id}-elasticsearch/{ref id}-remote-clusters - Set remote clusters

PUT {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/remote-clusters

Overwrites or creates the remote clusters for the elasticsearch resource.

3. deployments-{deployment id}-elasticsearch/{ref id}-remote-clusters - Get remote clusters

GET {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/remote-clusters

Returns the list of remote clusters for the elasticsearch resource.

4. deployments-{deployment id}-elasticsearch/{ref id}-keystore - Add or remove settings from the Elasticsearch resource keystore

PATCH {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/keystore

Fetches the current values of the keystore for the Elasticsearch resource.

5. deployments-{deployment id}-elasticsearch/{ref id}-keystore - Get the settings from the Elasticsearch resource keystore

GET {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/keystore

Adds the specified values to the Elasticsearch keystore, or removes the keys for the unspecified values.

6. deployments-{deployment id}-elasticsearch/{ref id} - Get Deployment Elasticsearch Resource Info

GET {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id?show_security=false&show_metadata=false&show_plans=true&show_plan_logs=false&show_plan_history=false&show_plan_defaults=false&convert_legacy_plans=false&show_system_alerts=0&show_settings=false&enrich_with_template=true

Get info about an Elasticsearch Resource belonging to a given Deployment.

7. deployments-{deployment id}-elasticsearch/{ref id} - Shutdown Deployment Elasticsearch Resource

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_shutdown?hide=false&skip_snapshot=false

Shutdown Elasticsearch Resource belonging to a given Deployment.

8. deployments-{deployment id}-elasticsearch/{ref id} - Restart Deployment Elasticsearch Resource

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_restart?restore_snapshot=true&skip_snapshot=true&cancel_pending=false&group_attribute=__zone__&shard_init_wait_time=600

Restarts an Elasticsearch Resource. If a Resource is active: this command re-applies the existing plan but applies a cluster_reboot, which issues a restart command and waits for it to complete. If a Resource is inactive: this command starts it up with the most recent successful plan.

9. deployments-{deployment id}-elasticsearch/{ref id} - Migrate Elasticsearch resource to use SLM

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_enable-slm?validate_only=false

Migrates the specified Elasticsearch resource to use SLM.

10. deployments-{deployment id}-elasticsearch/{ref id} - Reset 'elastic' user password

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_reset-password

Resets the password of the 'elastic' user.

11. deployments-{deployment id}-elasticsearch/{ref id} - Migrate Elasticsearch and associated Kibana resources to enable CCR

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_enable-ccr?validate_only=false

Migrates the specified Elasticsearch resource and its associated Kibana to enable CCR (if supported).

12. deployments-{deployment id}-elasticsearch/{ref id} - Get eligible remote clusters

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/eligible-remote-clusters

Returns the list of deployments which contain eligible remote clusters for the elasticsearch resource.

13. deployments-{deployment id}-elasticsearch/{ref id} - Migrate Elasticsearch resource to use ILM

POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_enable-ilm?validate_only=false

Migrates the specified Elasticsearch resource to use ILM.

14. deployments-{deployment id}-{resource kind}/{ref id}-instances-{instance ids}-maintenance-mode - Start maintenance mode

POST {{baseUrl}}/deployments/:deployment_id/:resource_kind/:ref_id/instances/:instance_ids/maintenance-mode/_start?ignore_missing=false

Starts maintenance mode of instances belonging to a Deployment Resource.

15. deployments-{deployment id}-{resource kind}/{ref id}-instances-{instance ids}-maintenance-mode - Stop maintenance mode

POST {{baseUrl}}/deployments/:deployment_id/:resource_kind/:ref_id/instances/:instance_ids/maintenance-mode/_stop?ignore_missing=false

Stops maintenance mode of instances belonging to a Resource.

16. deployments-{deployment id}-{resource kind}/{ref id}-instances-{instance ids} - Stop instances

POST {{baseUrl}}/deployments/:deployment_id/:resource_kind/:ref_id/instances/:instance_ids/_stop?ignore_missing=false

Stops instances belonging to a Deployment Resource.

17. deployments-{deployment id}-{resource kind}/{ref id}-instances-{instance ids} - Start instances

POST {{baseUrl}}/deployments/:deployment_id/:resource_kind/:ref_id/instances/:instance_ids/_start?ignore_missing=false

Starts instances belonging to a Deployment Resource.

18. deployments-{deployment id}-{resource kind}/{ref id}-instances-maintenance-mode - Start maintenance mode (all instances)

POST {{baseUrl}}/deployments/:deployment_id/:resource_kind/:ref_id/instances/maintenance-mode/_start

Starts maintenance mode of all instances belonging to a Deployment Resource.

19. deployments-{deployment id}-{resource kind}/{ref id}-instances-maintenance-mode - Stop maintenance mode (all instances)

POST {{baseUrl}}/deployments/:deployment_id/:resource_kind/:ref_id/instances/maintenance-mode/_stop

Stops maintenance mode of all instances belonging to a Deployment Resource.

20. deployments-{deployment id}-{resource kind}/{ref id}-instances - Start all instances

POST {{baseUrl}}/deployments/:deployment_id/:resource_kind/:ref_id/instances/_start

Starts all instances belonging to a Deployment Resource.

21. deployments-{deployment id}-{resource kind}/{ref id}-instances - Stop all instances

POST {{baseUrl}}/deployments/:deployment_id/:resource_kind/:ref_id/instances/_stop

Stops all instances belonging to a Deployment Resource.

22. deployments-{deployment id}-{resource kind}/{ref id} - Restores a shutdown resource

POST {{baseUrl}}/deployments/:deployment_id/:resource_kind/:ref_id/_restore?restore_snapshot=false

Restores a shutdown resource belonging to a given Deployment.

23. deployments-{deployment id}-{resource kind}/{ref id} - Cancel resource pending plan

DELETE {{baseUrl}}/deployments/:deployment_id/:resource_kind/:ref_id/plan/pending?force_delete=false&ignore_missing=false

Cancels the pending plan of a Resource belonging to a given Deployment.

24. deployments-{deployment id}-apm/{ref id} - Get Deployment APM Resource Info

GET {{baseUrl}}/deployments/:deployment_id/apm/:ref_id?show_metadata=false&show_plans=true&show_plan_logs=false&show_plan_history=false&show_plan_defaults=false&show_settings=false

Get info about an APM Resource belonging to a given Deployment.

25. deployments-{deployment id}-apm/{ref id} - Reset the secret token for an APM resource.

POST {{baseUrl}}/deployments/:deployment_id/apm/:ref_id/_reset-token

Reset the token of an APM resource.

26. deployments-{deployment id}-appsearch/{ref id}-read only mode - Set AppSearch read-only status

PUT {{baseUrl}}/deployments/:deployment_id/appsearch/:ref_id/read_only_mode

Enable/Disable read-only mode on the given App Search resource.

27. deployments-{deployment id}-appsearch/{ref id}-read only mode - Set AppSearch read-only status

GET {{baseUrl}}/deployments/:deployment_id/appsearch/:ref_id/read_only_mode

Enable/Disable read-only mode on the given App Search resource.

28. deployments-{deployment id}-appsearch/{ref id} - Get Deployment App Search Resource Info

GET {{baseUrl}}/deployments/:deployment_id/appsearch/:ref_id?show_metadata=false&show_plans=true&show_plan_logs=false&show_plan_history=false&show_plan_defaults=false&show_settings=false

Get info about an App Search Resource belonging to a given Deployment.

29. deployments-{deployment id}-{stateless resource kind}/{ref id} - Restart Deployment Stateless Resource

POST {{baseUrl}}/deployments/:deployment_id/:stateless_resource_kind/:ref_id/_restart?cancel_pending=false

Restarts a Stateless Resource. If a Resource is active: this command re-applies the existing plan but applies a cluster_reboot, which issues a restart command and waits for it to complete. If a Resource is inactive: this command starts it up with the most recent successful plan.

30. deployments-{deployment id}-{stateless resource kind}/{ref id} - Shutdown Deployment Stateless Resource

POST {{baseUrl}}/deployments/:deployment_id/:stateless_resource_kind/:ref_id/_shutdown?hide=true&skip_snapshot=false

Shut down Stateless Resource belonging to a given Deployment. Kibana cannot be shut down on Elasticsearch Service as it is required for Elasticsearch administrative functions, such as Snapshot Lifecycle Management and version upgrades.

31. deployments-{deployment id}-{stateless resource kind}/{ref id} - Upgrade Kibana, APM, AppSearch inside Deployment

POST {{baseUrl}}/deployments/:deployment_id/:stateless_resource_kind/:ref_id/_upgrade?validate_only=false

Upgrades a running cluster.

32. deployments-{deployment id} - Update Deployment

PUT {{baseUrl}}/deployments/:deployment_id?hide_pruned_orphans=false&skip_snapshot=false&validate_only=false&version=minim voluptate

Updates a Deployment.

33. deployments-{deployment id} - Get Deployment

GET {{baseUrl}}/deployments/:deployment_id?show_security=false&show_metadata=false&show_plans=true&show_plan_logs=false&show_plan_history=false&show_plan_defaults=false&convert_legacy_plans=false&show_system_alerts=0&show_settings=false&enrich_with_template=true

Retrieves information about a Deployment.

34. deployments-{deployment id} - Restores a shutdown Deployment

POST {{baseUrl}}/deployments/:deployment_id/_restore?restore_snapshot=false

Restores all resources in a Deployment.

35. deployments-{deployment id} - Get Deployment Enterprise Search Resource Info

GET {{baseUrl}}/deployments/:deployment_id/enterprise_search/:ref_id?show_metadata=false&show_plans=true&show_plan_logs=false&show_plan_history=false&show_plan_defaults=false&show_settings=false

Get info about an Enterprise Search Resource belonging to a given Deployment.

36. deployments-{deployment id} - Get Deployment Kibana Resource Info

GET {{baseUrl}}/deployments/:deployment_id/kibana/:ref_id?show_metadata=false&show_plans=true&show_plan_logs=false&show_plan_history=false&show_plan_defaults=false&convert_legacy_plans=false&show_settings=false

Get info about a Kibana Resource belonging to a given Deployment.

37. deployments-{deployment id} - Shuts down Deployment

POST {{baseUrl}}/deployments/:deployment_id/_shutdown?hide=true&skip_snapshot=false

Shuts down all resources in a Deployment.

38. deployments-{deployment id} - Build Migrate Deployment Template request

POST {{baseUrl}}/deployments/:deployment_id/_migrate?template=minim voluptate

Returns a deployment update request that would transform this deployment from its template to the provided one.

39. deployments-templates - Get deployment templates

GET {{baseUrl}}/deployments/templates?metadata=minim voluptate&stack_version=minim voluptate&region=minim voluptate

Retrieves all deployment templates.

40. deployments-templates - Get deployment template

GET {{baseUrl}}/deployments/templates/:template_id?stack_version=minim voluptate&region=minim voluptate

Retrieves a deployment template by id.

41. deployments-traffic-filter-rulesets-{ruleset id}-associations - Create ruleset association

POST {{baseUrl}}/deployments/traffic-filter/rulesets/:ruleset_id/associations

Applies the ruleset to the specified deployment.

42. deployments-traffic-filter-rulesets-{ruleset id}-associations - Get associated deployments

GET {{baseUrl}}/deployments/traffic-filter/rulesets/:ruleset_id/associations

Retrieves a list of deployments that are associated to the specified ruleset.

43. deployments-traffic-filter-rulesets-{ruleset id}-associations - Delete ruleset association

DELETE {{baseUrl}}/deployments/traffic-filter/rulesets/:ruleset_id/associations/:association_type/:associated_entity_id

Deletes the traffic rules in the ruleset from the deployment.

44. deployments-traffic-filter-rulesets-{ruleset id} - Updates a ruleset

PUT {{baseUrl}}/deployments/traffic-filter/rulesets/:ruleset_id

Updates the ruleset with the definition.

45. deployments-traffic-filter-rulesets-{ruleset id} - Delete a ruleset

DELETE {{baseUrl}}/deployments/traffic-filter/rulesets/:ruleset_id?ignore_associations=false

Deletes the ruleset by ID.

46. deployments-traffic-filter-rulesets-{ruleset id} - Retrieves the ruleset by ID.

GET {{baseUrl}}/deployments/traffic-filter/rulesets/:ruleset_id?include_associations=false

Retrieves a list of resources that are associated to the specified ruleset.

47. deployments-traffic-filter-rulesets - Create a ruleset

POST {{baseUrl}}/deployments/traffic-filter/rulesets

Creates a ruleset that consists of a set of rules.

48. deployments-traffic-filter-rulesets - List traffic filter rulesets

GET {{baseUrl}}/deployments/traffic-filter/rulesets?include_associations=false&region=minim voluptate

List all of the traffic filter rulesets.

49. deployments-traffic-filter - Get associated rulesets

GET {{baseUrl}}/deployments/traffic-filter/associations/:association_type/:associated_entity_id/rulesets

Retrieves the rulesets associated with a deployment.

50. deployments-extensions-{extension id} - Uploads the Extension

PUT {{baseUrl}}/deployments/extensions/:extension_id

Uploads archive for an extension.

51. deployments-extensions-{extension id} - Update Extension

POST {{baseUrl}}/deployments/extensions/:extension_id

Updates an extension.

52. deployments-extensions-{extension id} - Delete Extension

DELETE {{baseUrl}}/deployments/extensions/:extension_id

Deletes a Extension.

53. deployments-extensions-{extension id} - Get Extension

GET {{baseUrl}}/deployments/extensions/:extension_id?include_deployments=false

Retrieves an extension.

54. deployments-extensions - Create an extension

POST {{baseUrl}}/deployments/extensions

Creates the extension. The extensions API supports two types of usage patterns. A). Specify a download_url, http or https URL, where the extension is currently hosted. This will result in extension being copied to elastic repository. B). Create only the extension metadata using the POST endpoint and then use PUT to upload the extension file. Leave the download_url unspecified in this case.

55. deployments-extensions - List Extensions

GET {{baseUrl}}/deployments/extensions?include_deployments=false

Retrieves all of the available extensions.

56. deployments - Create Deployment

POST {{baseUrl}}/deployments?request_id=minim voluptate&validate_only=false

Creates a Deployment.

57. deployments - List Deployments

GET {{baseUrl}}/deployments

List Deployments.

58. deployments - Search Deployments

POST {{baseUrl}}/deployments/_search

Retrieves the information for all of the deployments that match the specified query.