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

Shutdown Deployment Elasticsearch Resource

Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.

hide

If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible).

skip_snapshot

Standard response.

Added as a part of security scheme: apikey

Shutdown Deployment Elasticsearch Resource 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.

Shutdown Deployment Elasticsearch Resource 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

Get stack versions

Set remote clusters

Get remote clusters

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

Add or remove settings from the Elasticsearch resource keystore

Get the settings from the Elasticsearch resource keystore

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

Get Deployment Elasticsearch Resource Info

Restart Deployment Elasticsearch Resource

Migrate Elasticsearch resource to use SLM

Reset 'elastic' user password

Migrate Elasticsearch and associated Kibana resources to enable CCR

Get eligible remote clusters

Migrate Elasticsearch resource to use ILM

Start maintenance mode

Stop maintenance mode

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

Stop instances

Start instances

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

Start maintenance mode (all instances)

Stop maintenance mode (all instances)

deployments-{deployment id}-{resource kind}/{ref id}-instances-maintenance-mode

Start all instances

Stop all instances

deployments-{deployment id}-{resource kind}/{ref id}-instances

Restores a shutdown resource

Cancel resource pending plan

deployments-{deployment id}-{resource kind}/{ref id}

Get Deployment APM Resource Info

Reset the secret token for an APM resource.

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

Set AppSearch read-only status

deployments-{deployment id}-appsearch/{ref id}-read only mode

Get Deployment App Search Resource Info

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

Restart Deployment Stateless Resource

Shutdown Deployment Stateless Resource

Upgrade Kibana, APM, AppSearch inside Deployment

deployments-{deployment id}-{stateless resource kind}/{ref id}

Update Deployment

Get Deployment

Restores a shutdown Deployment

Get Deployment Enterprise Search Resource Info

Get Deployment Kibana Resource Info

Shuts down Deployment

Build Migrate Deployment Template request

deployments-{deployment id}

Get deployment templates

Get deployment template

deployments-templates

Create ruleset association

Get associated deployments

Delete ruleset association

deployments-traffic-filter-rulesets-{ruleset id}-associations

Updates a ruleset

Delete a ruleset

Retrieves the ruleset by ID.

deployments-traffic-filter-rulesets-{ruleset id}

Create a ruleset

List traffic filter rulesets

deployments-traffic-filter-rulesets

Get associated rulesets

deployments-traffic-filter

Uploads the Extension

Update Extension

Delete Extension

Get Extension

deployments-extensions-{extension id}

Create an extension

List Extensions

deployments-extensions

Create Deployment

List Deployments

Search Deployments

deployments

Delete API key

Get API key

users/auth/keys-{api key id}

Create API key

Delete API keys

Get all API keys

users/auth/keys

Updates the current account

Fetch current account information

account

Update trust relationship

Delete trust relationship

Get trust relationship

platform/configuration/trust-relationships-{trust relationship id}

Create trust relationship

List trust relationships

platform/configuration/trust-relationships

<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.

API Evangelist APIs | Elasticsearch API Integration | QodexAI API Network

Key	Datatype	Required	Description
hide	boolean		Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators.
skip_snapshot	boolean		If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible).