3. Conventions

Each service of Koios Automation Platform has its own REST API, reached through the platform gateway: automation controller under /api/controller/ (current version /api/controller/v2/), the platform gateway under /api/gateway/v1/, Event-Driven Ansible under /api/eda/v1/ and automation hub under /api/galaxy/. A GET on /api/controller/ shows the API versions of automation controller.

You may have to specify the content/type on POST or PUT requests accordingly.

  • PUT: Update a specific resource (by an identifier) or a collection of resources. PUT can also be used to create a specific resource if the resource identifier is known 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

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.