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.

« Steps Secure your settings »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.10] ›RESTful API ›API examples

Remove unwanted deployment templates and instance configurations

edit

Remove unwanted deployment templates and instance configurations

edit

If you configure the deployment templates in ECE and find that you created instance configurations or deployment templates that you no longer need, you can use these steps to delete them through the RESTful API. Alternatively, you can also use the UI to delete these artifacts.

Before you begin

edit

Deleting instance configurations or deployment templates does not affect existing deployments that got created from these artifacts, but you should still make sure that you no longer need these artifacts, as there is no undo function. You cannot delete system-owned instance configurations or deployment templates.

Steps

edit

To remove an instance configuration:

  1. List the available instance configurations to find out the ID for the instance configuration you want to delete:

    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/instances

  2. Delete the instance configuration using the ID:

    curl -k -X  DELETE -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/instances/INSTANCE_CONFIGURATION_ID
    INSTANCE_CONFIGURATION_ID
    The instance configuration ID as returned by the instance_configuration_id field

To remove a deployment template through the RESTful API:

  1. List the available deployment templates to find out the ID:

    curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/templates/deployments

  2. Delete the deployment templates using the ID:

    curl -k -X DELETE -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/templates/deployments/DEPLOYMENT_TEMPLATE_ID
    DEPLOYMENT_TEMPLATE_ID
    The deployment template ID as returned by the id field
« Steps Secure your settings »