New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
« API examples A first API call: What deployments are there? »
Elastic Docs ›Elastic Cloud Enterprise Reference [3.7] ›RESTful API ›API examples

Setting up your environment

edit

Setting up your environment

edit

These examples contain a few variables to help you test in your own environment. These include:

$ECE_API_KEY
The API key used to authenticate API calls on Elastic Cloud Enterprise. For details on generating and using an API key, check Authenticate using an API key.
$COORDINATOR_HOST
The address for the host that holds the coordinator role in your ECE installation. For example, in an AWS environment your coordinator host address would be in a format like ec2-x-xx-xxx-xx.compute-1.amazonaws.com.
$DEPLOYMENT_ID
The ID used to uniquely identify an ECE deployment. The first What deployments are there? example shows you how to display the existing deployments and their IDs.
$REF_ID
The unique ID for a resource in a deployment. This is first used in our Checking on progress example.

You can use an export command to set these variables in your shell environment, so that you can cut and paste each example into a terminal shell:

export ECE_API_KEY="YOUR_GENERATED_API_KEY"
export COORDINATOR_HOST="ec2-x-xx-xxx-xx.compute-1.amazonaws.com"

These API examples all use HTTPS over port 12443 and run against a host that holds the coordinator role. Using HTTPS requires that you have a TLS certificate already installed. For testing purposes only, you can specify the -k option to turn off certificate verification, as shown in our examples, or use HTTP over port 12400 until you get your TLS certificate sorted out.

« API examples A first API call: What deployments are there? »
Was this helpful?
Feedback