Delete Variables API removed

The deleteVariables API is now deprecated and removed from Itential Platform. You must now edit variables using Golden Config via the updateGoldenConfigTreeVersion API.

Golden Config variables

Golden Configuration previously did not support full-text editing. To modify a Golden Config, you would generate a data model through the UI and then replace elements of the model with variables, which were simple key/value pairs. To delete these variables, you would use the deleteVariables API and pass in the variable names to be deleted.

With current versions of the Platform, Golden Configuration has implemented a rich-text editor and Jinja2 support, alongside support for JSON variables. All the content of JSON variables can now be updated through a single update API by modifying the JSON itself. The API that enables this is updateGoldenConfigTreeVersion, in which variables can be passed in.

Since the structure of how variables are stored is now JSON, the deleteVariables API is no longer supported and provides no functionality to the Platform. Consequently, it has been deprecated and removed.

What should I do?

All supported versions of Configuration Manager (2022.1 and higher) use Jinja2 templates and JSON variables. The deleteVariables API is incompatible with Config Manager.

As a best practice, review any custom apps and adapters that might reference deleteVariables and update them to use the updateGoldenConfigTreeVersion API.

If you encounter any problems or need additional information, contact the Product Support Team.

Related reading: