Elastic Cloud API

Elastic Cloud API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from API Evangelist.

Elastic Cloud API | Elasticsearch Workspace | API documentation

Get Deployment Elasticsearch Resource Info

Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials.

show_security

Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.

show_metadata

Whether to include the full current and pending plan information in the response - can be large per cluster.

show_plans

Whether to include with the current and pending plan information the attempt log - can be very large per cluster.

show_plan_logs

Whether to include with the current and pending plan information the plan history- can be very large per cluster.

show_plan_history

If showing plans, whether to show values that are left at their default value (less readable but more informative).

show_plan_defaults

If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true').

convert_legacy_plans

Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.

show_system_alerts

Whether to show cluster settings in the response.

show_settings

If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on.

enrich_with_template

Standard response.

Added as a part of security scheme: apikey

Get Deployment Elasticsearch Resource Info deployments Elastic Cloud API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from API Evangelist.

Get Deployment Elasticsearch Resource Info deployments Elastic Cloud API | Elasticsearch Workspace | API documentation

deployments-{deployment id}-elasticsearch/{ref id}

deployments Elastic Cloud API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from API Evangelist.

deployments Elastic Cloud API | Elasticsearch Workspace | API documentation

<h2>Overview</h2>

<p>This workspace is meant to do the work of defining and evolving OpenAPI and collections for documenting, mocking, testing, and integrating with <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/rest-apis.html#rest-apis">Elasticsearch APIs</a>. All APIs and their collections are all work in progress, so please submit back any changes your fixes you make--this is a community effort!</p>

<h2>Participate</h2>

<p>Feel free to follow the OpenAPI, fork the collection, or leave a comment. We are looking to keep making the OpenAPI more relevant, while making the examples used to drive the mocks for robust, so please join in and help wherever you can.</p>

<h2>Support</h2>

<p>If you have any questions, feel free to email <a href="mailto:info@apievangelist.com">info@apievangelist.com</a>, or ping me at Twitter at @apievangelist. Ideally, we keep the conversation thread local within this workspace, but we are happy to answer general questions through other channels.</p>

<h2>This is Not an Official Elasticsearch Workspace</h2>

<p>This is meant to drive conversation around Elasticsearch APIs, but is not officially operated by Elasticsearch. If you work for Elasticsearch, please publish your own workspace and I am happy to remove this workspace and just begin forking your collections as part of stories here on API Evangelist—the community needs an OpenAPI and collections available for your APIs.</p>


Elasticsearch

Github

Twitter

Developer Website

Elasticsearch projects on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from API Evangelist.

Key	Datatype	Required	Description
show_security	boolean		Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials.
show_metadata	boolean		Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.
show_plans	boolean		Whether to include the full current and pending plan information in the response - can be large per cluster.
show_plan_logs	boolean		Whether to include with the current and pending plan information the attempt log - can be very large per cluster.
show_plan_history	boolean		Whether to include with the current and pending plan information the plan history- can be very large per cluster.
show_plan_defaults	boolean		If showing plans, whether to show values that are left at their default value (less readable but more informative).
convert_legacy_plans	boolean		If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true').
Curl curl -X GET 'https://api.elastic-cloud.com/api/v1//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?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' API Documentation Claim this page Report this page All Projects Powered byQodex.ai FAQs More Claim this page Report this page ENDPOINTS