Itential Automation Gateway

On this page:

Interactive API

The Automation Gateway API is documented with an interactive "try it out" UI within Automation Gateway. Users can execute operations against modules, roles, and playbooks that Automation Gateway oversees, or onboard and delete devices.

Add a New Device

Devices managed by Automation Gateway (i.e. "internal" mode) are manipulated and managed via API.

  1. Navigate to the API Documentation (see the Version Information, API Documentation & Logout section above).
  2. Click the appropriate Automation Gateway API method. For example, select POST /devices to add a new device.
  3. Click Try it out!.
  4. Edit the definition values to reflect the added device.
  5. Click Execute to run the call. Click Cancel to exit;changes will not be saved.
  6. The following information displays below the Responses header.
    • Curl command that could be run to achieve the same result.
    • Request URL is the actual REST call made to the server.
    • Server response from the executed call.
    • All possible response codes for the API call.

Figure 1: API Documentation

API Doc Screen


Figure 2: Try It Out

API Try it Out


Figure 3: Execute

API Execute Screen


Figure 4: Response

API Responses Screen

Remove a Device

  1. Go to the Devices family (left navigation menu) to see the new device that was added in the example above.
  2. Go to the API Documentation and select DELETE /devices/{device_name} to remove the added device.
  3. Click Try it out!.
  4. Enter the name of the device to be removed.
  5. Click Execute.

Figure 5: Delete Device

Delete Device Screen

Add a New Playbook

Once a new playbook is added to Ansible, it can be added to Automation Gateway.

  1. Navigate to API Documentation.
  2. Find and expand the POST /playbooks/refresh.
  3. Click Try it out!
  4. Click Execute to re-sync the playbooks.
  5. Verify the response code. Response Code 200 indicates the retrieval was successful.
  6. Go back to the Playbooks section of Automation Gateway to view the newly added playbook.

Figure 6: Add Playbook

API Add Playbook


Figure 7: Playbook Response

API Playbook Responses

Add a New Role

New roles must be added to Ansible first before they can be synchronized and viewed by Automation Gateway.

  1. Navigate to API Documentation.
  2. Find and expand the POST /roles/refresh.
  3. Click Try it out!
  4. Click Execute to refresh the cache and re-sync the roles with Ansible.
  5. Verify the response. Response Code 200 indicates the refresh was successful.
  6. Go back to the Roles section of Automation Gateway to view and use the new roles.

Figure 8: Post Roles

API Post Roles


Figure 9: Post Roles Response

API Post Roles Responses