Chapter 2. Browsing with the API


REST APIs give access to resources (data entities) through URI paths.

Procedure

  1. Go to the automation controller REST API in a web browser at:

    https://<gateway server name>/api/controller/v2

  2. Click the "v2" link next to "current versions" or "available versions". Automation controller supports version 2 of the API.
  3. Perform a GET with just the /api/ endpoint to get the current_version, which is the recommended version.
  4. Click the Copy icon on the navigation menu, for documentation on the access methods for that particular API endpoint and what data is returned when using those methods.
  5. Use the PUT and POST verbs on the specific API pages by formatting JSON in the various text fields.

You can also view changed settings from factory defaults at /api/v2/settings/changed/ endpoint. It reflects changes you made in the API browser, not changed settings that come from static settings files.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat, Inc.