- Elastic Cloud Control - The Command-Line Interface for Elasticsearch Service and ECE:
- Overview
- Installing
- Configuring
- Usage examples
- Command reference
- ecctl
- ecctl auth
- ecctl auth key
- ecctl auth key create
- ecctl auth key delete
- ecctl auth key list
- ecctl auth key show
- ecctl deployment
- ecctl deployment create
- ecctl deployment delete
- ecctl deployment elasticsearch
- ecctl deployment elasticsearch keystore
- ecctl deployment elasticsearch keystore show
- ecctl deployment elasticsearch keystore update
- ecctl deployment list
- ecctl deployment note
- ecctl deployment note create
- ecctl deployment note list
- ecctl deployment note show
- ecctl deployment note update
- ecctl deployment plan
- ecctl deployment plan cancel
- ecctl deployment resource
- ecctl deployment resource delete
- ecctl deployment resource restore
- ecctl deployment resource shutdown
- ecctl deployment resource start-maintenance
- ecctl deployment resource start
- ecctl deployment resource stop-maintenance
- ecctl deployment resource stop
- ecctl deployment resource upgrade
- ecctl deployment restore
- ecctl deployment resync
- ecctl deployment search
- ecctl deployment show
- ecctl deployment shutdown
- ecctl deployment template
- ecctl deployment template create
- ecctl deployment template delete
- ecctl deployment template list
- ecctl deployment template show
- ecctl deployment template update
- ecctl deployment update
- ecctl generate
- ecctl generate completions
- ecctl generate docs
- ecctl init
- ecctl platform
- ecctl platform allocator
- ecctl platform allocator list
- ecctl platform allocator maintenance
- ecctl platform allocator metadata
- ecctl platform allocator metadata delete
- ecctl platform allocator metadata set
- ecctl platform allocator metadata show
- ecctl platform allocator search
- ecctl platform allocator show
- ecctl platform allocator vacate
- ecctl platform constructor
- ecctl platform constructor list
- ecctl platform constructor maintenance
- ecctl platform constructor resync
- ecctl platform constructor show
- ecctl platform enrollment-token
- ecctl platform enrollment-token create
- ecctl platform enrollment-token delete
- ecctl platform enrollment-token list
- ecctl platform info
- ecctl platform instance-configuration
- ecctl platform instance-configuration create
- ecctl platform instance-configuration delete
- ecctl platform instance-configuration list
- ecctl platform instance-configuration pull
- ecctl platform instance-configuration show
- ecctl platform instance-configuration update
- ecctl platform proxy
- ecctl platform proxy filtered-group
- ecctl platform proxy filtered-group create
- ecctl platform proxy filtered-group delete
- ecctl platform proxy filtered-group list
- ecctl platform proxy filtered-group show
- ecctl platform proxy filtered-group update
- ecctl platform proxy list
- ecctl platform proxy show
- ecctl platform repository
- ecctl platform repository create
- ecctl platform repository delete
- ecctl platform repository list
- ecctl platform repository show
- ecctl platform role
- ecctl platform role create
- ecctl platform role delete
- ecctl platform role list
- ecctl platform role show
- ecctl platform role update
- ecctl platform runner
- ecctl platform runner list
- ecctl platform runner resync
- ecctl platform runner search
- ecctl platform runner show
- ecctl stack
- ecctl stack delete
- ecctl stack list
- ecctl stack show
- ecctl stack upload
- ecctl user
- ecctl user create
- ecctl user delete
- ecctl user disable
- ecctl user enable
- ecctl user key
- ecctl user key delete
- ecctl user key list
- ecctl user key show
- ecctl user list
- ecctl user show
- ecctl user update
- ecctl version
- Contributing
- Release notes
A newer version is available. For the latest information, see the
current release documentation.
Configuring
editConfiguring
editIn order for ecctl to be able to communicate with the RESTful API, it needs to have a set of configuration parameters defined. These parameters can be set in a configuration file, through environment variables, or at runtime using the CLI’s global flags.
Before you begin
editThe hierarchy for configuration parameters is as follows, from higher precedence to lower:
-
Command line flags
--host
,--user
,--pass
- Environment variables
-
Shared configuration file
$HOME/.ecctl/config.<json|toml|yaml|hcl>
Generate a configuration file
editIf it’s your first time using ecctl, use the init
command to assist you in generating a configuration file. The resulting configuration file will be saved under ~/.ecctl/config.json
:
$ ecctl init Welcome to the Elastic Cloud CLI! This command will guide you through authenticating and setting some default values. Missing configuration file, would you like to initialise it? [y/n]: y Select which type of Elastic Cloud offering will you be working with: [1] Elasticsearch Service (default). [2] Elastic Cloud Enterprise (ECE). [3] Elasticsearch Service Private (ESSP). Please enter your choice: 1 Using "https://api.elastic-cloud.com" as the API endpoint. Paste your API Key and press enter: xxxxx What default output format would you like? [1] text - Human-readable output format, commands with no output templates defined will fall back to JSON. [2] json - JSON formatted output API responses. Please enter a choice: 1 Your credentials seem to be valid, and show you're authenticated as "user". You're all set! Here is a command to try: $ ecctl deployment list
On this page
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register nowWas this helpful?
Thank you for your feedback.