It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Access the API from the Command Line
editAccess the API from the Command Line
editYou can interact with the full RESTful API for Elastic Cloud Enterprise directly from the command line through the curl command. When you use the command line to interact with the API, two authentication methods are available: key-based and token-based.
- Using an API key
-
You can generate an API key from the ECE UI, and then specify that key in the header of your API calls. This method has the advantage that, once set, the API key lasts indefinitely.
Once you’ve generated your API key, you need to include it in an HTTP "Authentication" header when making API requests:
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/deployments
Our API examples use the HTTPS protocol, which requires that you have a TLS certificate already installed. For testing purposes only, you can specify the
-koption to turn off certificate verification, as shown in our examples, or use HTTP over port 12400 until you get your TLS certificate sorted out. - Using a bearer token
-
You can also authenticate using a temporary bearer token. First, follow the steps to generate a bearer token.
You then need to include this token in an HTTP "Authentication" header when making API requests:
curl -k -X GET -H "Authorization: Bearer $TOKEN" https://$COORDINATOR_HOST:12443/api/v1/deployments
Tokens have a short life span, so you should not save them for the long term, and should expect to handle HTTP responses that indicate that you need to reauthenticate e.g. 401.
If this is your first time exploring the API, you can take a look at our API examples to learn more.