For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationRelease notes
DocumentationRelease notes
  • Itential Automation Gateway
    • Overview
    • Related terminology
    • Navigate UI
      • Inventory integration variables
      • Create and manage devices
      • Remove a device
      • Manage inventory via API
      • Inventory sources
      • Interactive devices
      • Inventory encryption
      • Device broker support
      • Interactive devices 2023.2
    • Automatic discovery in IAG
    • Use hidden keyword extension
    • Edit the description field
    • Edit JSON schema
    • Manage decorations
    • View audit logs
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • Viewing endpoints and methods
  • Testing methods
Itential Automation GatewayInventory devices

Interactive devices 2023.2

Was this page helpful?
Previous

Automatic discovery in IAG

Next
Built with

Viewing endpoints and methods

To view details about various endpoints and methods:

1

Open the API documentation

Hover your cursor over the Menu button located in the upper-right corner of the side navigation menu. In the menu that appears, click API Documentation. The API Documentation panel opens on the right side of the screen.

Opening the interactive API documentation
2

Expand the Inventory resource

On the API Documentation panel, available API resources are organized by header. Click the Inventory header to display the methods of the Inventory resource.

3

Select the POST method

Click the POST /inventories/http_requests/{inventory_name}/devices method to display detailed information about the method, including:

  • A brief description of the method.
  • Method parameters.
  • A list of responses that can be returned from the related endpoint.
HTTP device creation method

Testing methods

To test the method:

1

Enable editing mode

Click the Try it out button located to the right of the Parameters header. The request body becomes editable and an Execute button appears.

2

Modify the request body

Modify the request body as desired. For more information, see Inventory integration variables.

3

Execute the request

Click the Execute button. The endpoint response will be displayed in JSON format.

Executing a method