Chapter 3. Use conventions in the API


Automation controller uses a standard REST API, rooted at /api/ on the server.

The API is versioned for compatibility reasons. You can see what API versions are available by querying /api/.

You might have to specify the content or type on POST or PUT requests:

  • PUT: Update a specific resource (by an identifier) or a collection of resources. You can also use PUT to create a specific resource if you know the resource identifier before-hand.
  • POST: Create a new resource. Also acts as a catch-all verb for operations that do not fit into the other categories.

All URIs not ending with "/" receive a 301 redirect.

Note

The formatting of extra_vars attached to Job Template records is preserved. YAML is returned as YAML with formatting and comments preserved, and JSON is returned as JSON.

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.

© 2024 Red Hat, Inc.