ITitential
Inventory Manager

Create a new inventory

Changed on

Creates a new inventory with the specified name and optional properties.

post/inventory_manager/v1/inventories

Request

  • Base URL
    https://example.itential.io
  • URL
    https://example.itential.io/inventory_manager/v1/inventories
  • Auth
    none declared

Request body

namestring

The name of the inventory

descriptionstring

Description of the inventory

groupsstring[]

Array of group names that will have access to this inventory (at least one group required)

tagsstring[]

Array of tag names to associate with this inventory. Tags will be automatically created if they don't exist.

createBrokerActionsboolean

Automatically create built-in broker actions (get-config, set-config, run-command, is-alive) for device broker compatibility. Custom actions with the same name will override the default broker actions.

defaultClusterIdstring

Default cluster ID for built-in broker actions. Required when createBrokerActions is enabled.

Response

Response from creating an inventory

statusstring
messagestring

Success message

Changes