elastic · kilfoyle · Jul 17, 2025 · Jul 15, 2025 · Jul 16, 2025 · Jul 16, 2025
@@ -71,7 +71,7 @@ Custom plugins can include the official {{es}} plugins not provided with {{ece}}
                     "elasticsearch_version" : "<es_version>" <2>
                   },
                   {
-                    "url": "http://www.MYURL.com/my-custom-plugin.zip",
+                    "url": "<MY_HOST_URL>/my-custom-plugin.zip",
                     "name": "my-custom-plugin",
                     "elasticsearch_version": "7.17.1"
                   }
@@ -105,7 +105,7 @@ This example adds a custom LDAP bundle for deployment level role-based access co
                 "user_bundles": [
                 {
                   "name": "ldap-cert",
-                  "url": "http://www.MYURL.com/ldapcert.zip", <1>
+                  "url": "<MY_HOST_URL>/ldapcert.zip", <1>
                   "elasticsearch_version": "*"
                 }
               ]
@@ -151,7 +151,7 @@ In this example, we assume the Identity Provider does not publish its SAML metad
                 "user_bundles": [
                 {
                   "name": "saml-metadata",
-                  "url": "http://www.MYURL.com/saml-metadata.zip", <1>
+                  "url": "<MY_HOST_URL>/saml-metadata.zip", <1>
                   "elasticsearch_version": "*"
                 }
               ]
@@ -254,7 +254,7 @@ To import a JVM trust store:
                 "user_bundles": [
                 {
                   "name": "custom-ca-certs",
-                  "url": "http://www.MYURL.com/cacerts.zip", <1>
+                  "url": "<MY_HOST_URL>/cacerts.zip", <1>
                   "elasticsearch_version": "*" <2>
                 }
               ]
@@ -309,7 +309,7 @@ To import a JVM trust store:
                 "user_bundles": [
                 {
                   "name": "custom-geoip-db",
-                  "url": "http://www.MYURL.com/my-geoip-file.zip",
+                  "url": "<MY_HOST_URL>/my-geoip-file.zip",
                   "elasticsearch_version": "*"
                 }
               ]
@@ -359,7 +359,7 @@ To import a JVM trust store:
                 "user_bundles": [
                 {
                   "name": "custom-synonyms",
-                  "url": "http://www.MYURL.com/synonyms.zip",
+                  "url": "<MY_HOST_URL>/synonyms.zip",
                   "elasticsearch_version": "*"
                 }
               ]

@@ -1418,7 +1418,7 @@ Having added support for `node_roles` and autoscaling to your custom template, i
 1. Obtain the existing deployment templates by sending the following `GET` request, and take note of the `id` of the template you wish to update.
 
     ```sh
-    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
+    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
     ```
 
 2. Send a `PUT` request with the updated template on the payload, in order to effectively replace the outdated template with the new one. Note that the following request is just an example, you have to replace `{{template_id}}` with the `id` you collected on step 1. and set the payload to the updated template JSON. Check [set deployment template API](https://www.elastic.co/docs/api/doc/cloud-enterprise/operation/operation-set-deployment-template-v2) for more details.

@@ -15,8 +15,8 @@ products:
 By default, the deployments `CNAME` is set to `LOCAL_HOST_IP.ip.es.io`, where `LOCAL_HOST_IP` is the IP address of the first installed ECE host. This results in the following default endpoint URLs:
 
 ```sh
-http://CLUSTER_ID.LOCAL_HOST_IP.ip.es.io:9200
-https://CLUSTER_ID.LOCAL_HOST_IP.ip.es.io:9243
+http://<CLUSTER_ID.LOCAL_HOST_IP>.ip.es.io:9200
+https://<CLUSTER_ID.LOCAL_HOST_IP>.ip.es.io:9243
 ```
 
 ::::{important}

@@ -42,7 +42,7 @@ $$$fill-anti-affinity$$$`fill-anti-affinity` (default)
 To check how allocator affinity is currently configured:
 
 ```sh
-curl -X GET -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor
+curl -X GET -u admin:PASSWORD -k https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor
 {
   "errors": [{
     "code": "platform.config.store.not_found",
@@ -56,7 +56,7 @@ If a configuration option cannot be found, the default `fill-anti-affinity` stra
 To set allocator affinity to the `distribute-anti-affinity` strategy:
 
 ```sh
-curl -X POST -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor -H 'Content-Type: application/json' -d '{ "value": "{ \"allocator_prioritization\": \"distribute-anti-affinity\" }" }'
+curl -X POST -u admin:PASSWORD -k https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor -H 'Content-Type: application/json' -d '{ "value": "{ \"allocator_prioritization\": \"distribute-anti-affinity\" }" }'
 {
   "changed": false,
   "name": "constructor",
@@ -67,7 +67,7 @@ curl -X POST -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform
 To update allocator affinity to the `distribute` strategy:
 
 ```sh
-curl -X PUT -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor -H 'Content-Type: application/json' -d '{ "value": "{ \"allocator_prioritization\": \"distribute\" }" }'
+curl -X PUT -u admin:PASSWORD -k https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor -H 'Content-Type: application/json' -d '{ "value": "{ \"allocator_prioritization\": \"distribute\" }" }'
 {
   "changed": true,
   "name": "constructor",
@@ -78,7 +78,7 @@ curl -X PUT -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/
 To change allocator affinity back to the default behavior:
 
 ```sh
-curl -X DELETE -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor
+curl -X DELETE -u admin:PASSWORD -k https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor
 {
 
 }

@@ -144,7 +144,7 @@ Make sure to use a supported combination of Linux distribution and container eng
 
     ```text
     [engine]
-    env = ["HTTP_PROXY=http://{proxy-ip}:{proxy-port}", "HTTPS_PROXY=http://{proxy-ip}:{proxy-port}"]
+    env = ["HTTP_PROXY=http://<PROXY_IP>:<PROXY_PORT>", "HTTPS_PROXY=http://<PROXY_IP>:<PROXY_PORT>"]
     ```
 
 7. Reload systemd configuration

@@ -32,7 +32,7 @@ Once you have the endpoint, use it in your client application. To test connectiv
 * Modify the following `curl` example to fit your environment by replacing the URL and proxy CA certificate with your own values.
 
   ```sh
-  curl --cacert /path/to/elastic-ece-ca-cert.pem -u elastic https://f76e96da2a7f4d3f8f3ee25d686b879c.HOST-IP-ADDRESS.ip.es.io:9243
+  curl --cacert /path/to/elastic-ece-ca-cert.pem -u elastic https://<CLUSTER_ID.LOCAL_HOST_IP>.ip.es.io:9243
   {
     "name" : "instance-0000000000",
     "cluster_name" : "f76e96da2a7f4d3f8f3ee25d686b879c",

@@ -28,7 +28,7 @@ The API user must have the `Platform admin` role in order to configure system te
 1. Obtain the existing system deployment template you wish to modify. Note the `id` of the system deployment template as you will include this value in the API call to edit the template.
 
     ```sh
-    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
+    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
     ```
 
 2. Edit the JSON of the system deployment template you wish to modify.

@@ -89,7 +89,7 @@ Before you start creating your own deployment templates, you should have: [tagge
 1. Obtain the existing deployment templates to get some examples of what the required JSON looks like. You can take the JSON for one of the existing templates and modify it to create a new template, similar to what gets shown in the next step.
 
     ```sh
-    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
+    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
     ```
 
 2. Post the JSON for your new deployment template.

@@ -60,15 +60,15 @@ Before you start creating your own instance configurations, you should have [tag
 1. Obtain the existing instance configurations to get some examples of what the required JSON looks like. You can take the JSON for one of the existing configurations and modify it to create a new instance configuration, similar to what gets shown in the next step.
 
     ```sh
-    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/platform/configuration/instances
+    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/instances
     ```
 
 2. Post the JSON for your new instance configuration.
 
     The following examples creates an instance configuration for machine learning with size increments that start at the recommended minimum of 16 GB of memory. To make sure that machine learning nodes get deployed only on the right allocators, this instance configuration also filters for [allocator tags from our earlier example](ece-configuring-ece-tag-allocators.md) to match only allocators with high CPU resources and SSD storage.
 
     ```sh
-    curl -k -X POST -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/platform/configuration/instances -H 'content-type: application/json' -d '{
+    curl -k -X POST -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/instances -H 'content-type: application/json' -d '{
      "name": "Machine Learning Only",
       "description": "Custom machine learning instance configuration",
       "storage_multiplier": 32.0,

@@ -77,7 +77,7 @@ If you have an allocator that meets several criteria, such as an allocator with
 1. Get a list of the allocators in your ECE installation:
 
     ```sh
-    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators
+    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators
     ```
 
     ::::{note}
@@ -87,7 +87,7 @@ If you have an allocator that meets several criteria, such as an allocator with
 2. $$$check-allocator-tags$$$Check what tags have already been assigned to your allocators. In a new or newly upgraded ECE installation, this command returns `[]`, which means that you have not assigned any tags, yet.
 
     ```sh
-    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators/ALLOCATOR_ID/metadata
+    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators/ALLOCATOR_ID/metadata
     ```
 
     `ALLOCATOR_ID`
@@ -102,7 +102,7 @@ If you have an allocator that meets several criteria, such as an allocator with
     * Example: To assign a single `highCPU: true` tag to an allocator:
 
         ```sh
-        curl -k -X PUT -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators/ALLOCATOR_ID/metadata/highCPU  -H 'content-type: application/json' -d '{ "value": "true" }'
+        curl -k -X PUT -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators/ALLOCATOR_ID/metadata/highCPU  -H 'content-type: application/json' -d '{ "value": "true" }'
         [{
           "key": "highCPU",
           "value": "true"
@@ -114,7 +114,7 @@ If you have an allocator that meets several criteria, such as an allocator with
     * Example: To assign multiple tags to an allocator with a single command:
 
         ```sh
-        curl -k -X PUT -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators/ALLOCATOR_ID/metadata -H 'content-type: application/json' -d '
+        curl -k -X PUT -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators/ALLOCATOR_ID/metadata -H 'content-type: application/json' -d '
         {
           "items": [
             {

@@ -54,13 +54,13 @@ This returns a healthy response as:
 For {{ece}} 2.1 and later, the health check endpoint has changed. You can use `/_health` on proxy hosts with a result of either a 200 OK to indicate healthy or a 502 Bad Gateway response for unhealthy. A healthy response also means that internal routing tables in the proxy are valid and initialized, but not necessarily up-to-date.
 
 ```
-http://PROXY_ADDRESS:9200/_health
+http://<PROXY_ADDRESS>:9200/_health
 ```
 
 or
 
 ```
-https://PROXY_ADDRESS:9243/_health
+https://<PROXY_ADDRESS>:9243/_health
 ```
 
 This returns a healthy response as:

@@ -51,7 +51,7 @@ The permitted roles are the same as those you can [assign in the Cloud UI](./ass
 To generate an ephemeral token for additional allocators:
 
 ```sh
-curl -H 'Content-Type: application/json' -u USER:PASSWORD https://COORDINATOR_HOST_IP:12443/api/v1/platform/configuration/security/enrollment-tokens -d '{ "persistent": false, "roles": [ "allocator"] }'
+curl -H 'Content-Type: application/json' -u USER:PASSWORD https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/security/enrollment-tokens -d '{ "persistent": false, "roles": [ "allocator"] }'
 {
   "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI0Njk3N2I3ZC1hM2U2LTQ2MDUtYjcwZC0xNzIzMTI5YWY4ZTQiLCJyb2xlcyI6WyJwcm94eSIsImFsbG9jYXRvciJdLCJpc3MiOiJib290c3RyYXAtaW5pdGlhbCIsImV4cCI6MTQ5MzY0NjIxM30.xsaRb72CsNMuXKy6Y-PJgqLc0qmjCljlB4Smcx_MRxg"
 }
@@ -60,7 +60,7 @@ curl -H 'Content-Type: application/json' -u USER:PASSWORD https://COORDINATOR_HO
 To generate a persistent token for additional allocators:
 
 ```sh
-curl -H 'Content-Type: application/json' -u USER:PASSWORD https://COORDINATOR_HOST_IP:12443/api/v1/platform/configuration/security/enrollment-tokens -d '{ "persistent": true, "roles": [ "allocator"] }'
+curl -H 'Content-Type: application/json' -u USER:PASSWORD https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/security/enrollment-tokens -d '{ "persistent": true, "roles": [ "allocator"] }'
 {
   "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI0Yzg5OTBkZi0xZmI3LTQ4MjAtYjg2OC02YmM5ZTg4NjA4MTQiLCJyb2xlcyI6WyJwcm94eSIsImFsbG9jYXRvciJdLCJpc3MiOiJib290c3RyYXAtaW5pdGlhbCJ9.mfTkO4j8uZJ-qwB2jmBuMScyYfLmcJpvKgSTLx2WV24",
   "token_id": "4c8990df-1fb7-4820-b868-6bc9e8860814"

@@ -15,8 +15,8 @@ To access the Cloud UI in a web browser:
 1. Connect to one of the URLs provided at the end of the installation process on your first host, replacing `FIRST_HOST` with the correct IP address or DNS hostname.
 
     ```sh
-    http://FIRST_HOST:12400
-    https://FIRST_HOST:12443
+    http://<FIRST_HOST>:12400
+    https://<FIRST_HOST>:12443
     ```
 
     Secure access through the HTTPS protocol is available with certificates generated during the installation of {{ece}}, but will prompt you with a warning in your browser. To avoid this warning, you can add [your own TLS/SSL security certificates](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md). If you are on AWS and can’t access the Cloud UI, [check if the URL points to a private IP address](../../../troubleshoot/deployments/cloud-enterprise/common-issues.md#ece-aws-private-ip).

@@ -294,13 +294,13 @@ To obtain information about available {{stack}} versions through the Cloud UI:
 To obtain information about available {{stack}} versions through the command line:
 
 ```sh
-curl -X GET -u USER:PASSWORD https://COORDINATOR_HOST:12443/api/v1/stack/versions
+curl -X GET -u USER:PASSWORD https://$COORDINATOR_HOST:12443/api/v1/stack/versions
 ```
 
 For example (output abridged for brevity):
 
 ```
-curl -X GET -u admin:4Z52y8Gq7PrxMDy47ipJPSh4ozBMynOGa9HWxcy2D3j https://10.56.12.153:12443/api/v1/stack/versions
+curl -X GET -u admin:<cluster-id> https://<host-ip>:12443/api/v1/stack/versions
 {
   "stacks": [
     {
@@ -362,7 +362,7 @@ curl -X GET -u admin:4Z52y8Gq7PrxMDy47ipJPSh4ozBMynOGa9HWxcy2D3j https://10.56.1
   ]
 }
 ```
-You can also query for a specific version with a URI such as `https://COORDINATOR_HOST:12443/api/v1/stack/versions/5.3.2`, for example.
+You can also query for a specific version with a URI such as `https://$COORDINATOR_HOST:12443/api/v1/stack/versions/5.3.2`, for example.
 
 
 ## Add {{stack}} packs [ece-manage-elastic-stack-add]
@@ -409,7 +409,7 @@ To add a new {{stack}} pack through the RESTful API from the command line:
 2. Add the {{stack}} pack with the following API call:
 
     ```sh
-    curl -X POST -u USER:PASSWORD https://COORDINATOR_HOST:12443/api/v1/stack/versions \
+    curl -X POST -u USER:PASSWORD https://$COORDINATOR_HOST:12443/api/v1/stack/versions \
         -H 'content-type: application/zip' \
         --data-binary "@PATH/STACK_PACK_FILE" <1>
     ```
@@ -420,7 +420,7 @@ To add a new {{stack}} pack through the RESTful API from the command line:
     For example:
 
     ```sh
-    curl -X POST -u admin:pGX5DwKzVAAIeCIpTwwAkCuJDu0ASdFP33UmYpfogfF https://10.56.12.153:12443/api/v1/stack/versions \
+    curl -X POST -u admin:pGX5DwKzVAAIeCIpTwwAkCuJDu0ASdFP33UmYpfogfF <host-url>:12443/api/v1/stack/versions \
         -H 'content-type: application/zip' \
         --data-binary "@/Users/iuriitceretian/Documents/stacks/5.4.0.zip"
     ```
@@ -451,7 +451,7 @@ To update {{stack}} packs through the RESTful API from the command line:
 2. Update the {{stack}} pack with the following API call:
 
     ```sh
-    curl -X PUT -u USER:PASSWORD https://COORDINATOR_HOST:12443/api/v1/stack/versions/VERSION \ <1>
+    curl -X PUT -u USER:PASSWORD https://$COORDINATOR_HOST:12443/api/v1/stack/versions/VERSION \ <1>
         -H 'content-type: application/zip' \
         --data-binary "@PATH/STACK_PACK_FILE" <2>
     ```
@@ -463,7 +463,7 @@ To update {{stack}} packs through the RESTful API from the command line:
     For example:
 
     ```sh
-    curl -X PUT -u admin:pGX5DwKzVAAIeCIpTwAAkCuJDu0ASdFP33UmYpfogfF https://10.58.12.153:12443/api/v1/stack/versions/6.4.0 \
+    curl -X PUT -u admin:pGX5DwKzVAAIeCIpTwAAkCuJDu0ASdFP33UmYpfogfF https://$COORDINATOR_HOST:12443/api/v1/stack/versions/6.4.0 \
         -H 'content-type: application/zip' \
         --data-binary "@/Users/johnsmith/Documents/stacks/6.4.0.zip"
     ```
@@ -174,7 +174,7 @@ Using Docker or Podman as container runtime is a configuration local to the host
 
     ```text
     [engine]
-    env = ["HTTP_PROXY=http://{proxy-ip}:{proxy-port}", "HTTPS_PROXY=http://{proxy-ip}:{proxy-port}"]
+    env = ["HTTP_PROXY=http://<PROXY_IP>:<PROXY_PORT>", "HTTPS_PROXY=http://<PROXY_IP>:<PROXY_PORT>"]
     ```
 
 7. Reload systemd configuration