Stability of the Apache Ambari REST-API

[#1]

Hey everyone,
I am starting to work with Apache Ambari and I have to realize a System to get a short Overview over all Ambari Instances in one place.
My first approach is to connect to the Ambari-REST API and extract the relevant metadata. My colleagues told me, that the datamodel can be changed in the upgrade process of Ambari to a next Version.
Now my Querstion, can I use the REST-API for my use-Case even if Ambari will be upgraded periodically.

Before I want to start programming, I want to weigh up all possible approaches.

I see forward for your feedback

Best regards
Dominik

[#2 · Accepted solution]

The API is versioned, and I have not been aware of many changes in the structure of the data model, only the amount that is data that is returned with the addition of new services in each release of HDP, for example.

Depending on the size of your cluster, http://ambari-server:8080/api/v1/clusters/:cluster_name/ returns a lot of information

You can find all the documentation for the API here https://github.com/apache/ambari/tree/trunk/ambari-server/docs/api/v1

There is a ticket to get SwaggerUI documentation so the API is easier to navigate: https://issues.apache.org/jira/browse/AMBARI-20435

[#3]

Do you think the Api will be the same in future-Releases of Ambari. I don’t want to start program and in the next release the API will Change fundamentally and I have to modify my Software.

[#4]

Again, the API is versioned. If there are any major breaking changes, one should expect there to be a v2.

If you just look at the Github trunk, then you'll see that the API spec has not changed in years, and the latest commits have been typo and hyperlink fixes.