Type to search.

cloud hosted deployments cli namespace

Serverless Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack Preview

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Shell 
elastic cloud hosted deployments --help

Cloud hosted deployments commands

list-deployments

List Deployments

 create-deployment

Create Deployment

 search-deployments

Search Deployments

 search-eligible-remote-clusters

Get eligible remote clusters

 get-deployment

Get Deployment

 update-deployment

Update Deployment

 restore-deployment

Restores a shutdown Deployment

 shutdown-deployment

Shuts down Deployment

 get-deployment-apm-resource-info

Get Deployment APM Resource Info

 deployment-apm-reset-secret-token

Reset the secret token for an APM resource.

 get-deployment-appsearch-resource-info

Get Deployment App Search Resource Info

 get-appsearch-read-only-mode

Set AppSearch read-only status

 set-appsearch-read-only-mode

Set AppSearch read-only status

 get-deployment-certificate-authority

Get certificate authority

 get-deployment-es-resource-info

Get Deployment Elasticsearch Resource Info

 enable-deployment-resource-ccr

Migrate Elasticsearch and associated Kibana resources to enable CCR

 enable-deployment-resource-ilm

Migrate Elasticsearch resource to use ILM

 enable-deployment-resource-slm

Migrate Elasticsearch resource to use SLM

 reset-elasticsearch-user-password

Reset 'elastic' user password

 restart-deployment-es-resource

Restart Deployment Elasticsearch Resource

 shutdown-deployment-es-resource

Shutdown Deployment Elasticsearch Resource

 get-deployment-es-resource-eligible-remote-clusters

Get eligible remote clusters

 get-deployment-es-resource-keystore

Get the items in the Elasticsearch resource keystore

 set-deployment-es-resource-keystore

Add or remove items from the Elasticsearch resource keystore

 get-deployment-es-resource-remote-clusters

Get certificate based remote clusters

 set-deployment-es-resource-remote-clusters

Set certificate based remote clusters

 get-deployment-es-resource-snapshot-repository

List the attached snapshot repositories

 create-deployment-es-resource-snapshot-repository

Create a snapshot repository for Elasticsearch resource

 delete-deployment-es-resource-snapshot-repository

Remove the attached snapshot repository

 get-deployment-es-resource-tiers

Get Elasticsearch tiers

 update-deployment-es-resource-tier

Update Elasticsearch tiers

 get-deployment-enterprise-search-resource-info

Get Deployment Enterprise Search Resource Info

 get-deployment-integrations-server-resource-info

Get Deployment Integrations Server Resource Info

 get-deployment-kib-resource-info

Get Deployment Kibana Resource Info

 migrate-deployment-template

Build request to migrate deployment to a different template

 get-deployment-tags

Get the tags for a Deployment

 set-deployment-tags

Set the tags for a Deployment

 upgrade-deployment

Upgrade a Deployment to a new Elastic Stack version

 get-deployment-upgrade-assistant-status

Get Deployment upgrade assistant status

 restore-deployment-resource

Restores a shutdown resource

 start-deployment-resource-instances-all

Start all instances

 stop-deployment-resource-instances-all

Stop all instances

 start-deployment-resource-instances-all-maintenance-mode

Start maintenance mode (all instances)

 stop-deployment-resource-instances-all-maintenance-mode

Stop maintenance mode (all instances)

 start-deployment-resource-instances

Start instances

 stop-deployment-resource-instances

Stop instances

 start-deployment-resource-maintenance-mode

Start maintenance mode

 stop-deployment-resource-maintenance-mode

Stop maintenance mode

 cancel-deployment-resource-pending-plan

Cancel resource pending plan

 get-deployment-resource-user-settings

Get the user settings of a Deployment resource

 update-deployment-resource-user-settings

Update user settings for a deployment resource

 restart-deployment-stateless-resource

Restart Deployment Stateless Resource

 shutdown-deployment-stateless-resource

Shutdown Deployment Stateless Resource