Type to search.

ECE API examples: Remove unwanted deployment templates and instance configurations

ECE

Elastic Cloud Enterprise is a self-managed orchestration platform for deploying and managing the Elastic Stack at scale.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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.

Make sure that your deployment template is no longer in use by any deployment. You cannot delete system-owned instance configurations or deployment templates.

To remove an instance configuration:

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

    Shell 
    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:

    Shell 
    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:

    Shell 
    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:

    Shell 
    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