Create an Inventory

post

/api/v2/constructed_inventories/

Make a POST request to this resource with the following inventory fields to create a new inventory:

  • name: Name of this inventory. (string, required)
  • description: Optional description of this inventory. (string, default="")
  • organization: Organization containing this inventory. (id, required)

  • variables: Inventory variables in JSON or YAML format. (json, default=``)

  • prevent_instance_group_fallback: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean, default=False)

  • source_vars: The source_vars for the related auto-created inventory source, special to constructed inventory. (string, default="")
  • update_cache_timeout: The cache timeout for the related auto-created inventory source, special to constructed inventory (integer, default=None)
  • limit: The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. (string, default="")
  • verbosity: The verbosity level for the related auto-created inventory source, special to constructed inventory (integer, default=None)

Request

Supported Media Types
Body ()
Root Schema : ConstructedInventory
Type: object
Show Source
  • Title: Created
    Read Only: true
  • Title: Description
  • Title: Has active failures
    Read Only: true
    This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed.
  • Title: Has inventory sources
    Read Only: true
    This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources.
  • Title: Hosts with active failures
    Read Only: true
    Minimum Value: 0
    This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures.
  • Title: ID
    Read Only: true
  • Title: Inventory sources with failures
    Read Only: true
    Minimum Value: 0
    Number of external inventory sources in this inventory with failures.
  • Title: Kind
    Read Only: true
    Allowed Values: [ "", "smart", "constructed" ]
    Kind of inventory being represented.
  • Title: Limit
    The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory.
  • Title: Modified
    Read Only: true
  • Title: Name
    Minimum Length: 1
    Maximum Length: 512
  • Title: Organization
    Organization containing this inventory.
  • Title: Pending deletion
    Read Only: true
    Flag indicating the inventory is being deleted.
  • Title: Prevent instance group fallback
    If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
  • Title: Source vars
    The source_vars for the related auto-created inventory source, special to constructed inventory.
  • Title: Summary fields
    Read Only: true
  • Title: Total groups
    Read Only: true
    Minimum Value: 0
    This field is deprecated and will be removed in a future release. Total number of groups in this inventory.
  • Title: Total hosts
    Read Only: true
    Minimum Value: 0
    This field is deprecated and will be removed in a future release. Total number of hosts in this inventory.
  • Title: Total inventory sources
    Read Only: true
    Minimum Value: 0
    Total number of external inventory sources configured within this inventory.
  • Title: Type
    Read Only: true
  • Title: Update cache timeout
    Minimum Value: 0
    The cache timeout for the related auto-created inventory source, special to constructed inventory
  • Title: Url
    Read Only: true
  • Title: Variables
    Inventory variables in JSON or YAML format.
  • Title: Verbosity
    Minimum Value: 0
    Maximum Value: 2
    The verbosity level for the related auto-created inventory source, special to constructed inventory
Back to Top

Response

Supported Media Types

201 Response

Body ()
Root Schema : ConstructedInventory
Type: object
Show Source
  • Title: Created
    Read Only: true
  • Title: Description
  • Title: Has active failures
    Read Only: true
    This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed.
  • Title: Has inventory sources
    Read Only: true
    This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources.
  • Title: Hosts with active failures
    Read Only: true
    Minimum Value: 0
    This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures.
  • Title: ID
    Read Only: true
  • Title: Inventory sources with failures
    Read Only: true
    Minimum Value: 0
    Number of external inventory sources in this inventory with failures.
  • Title: Kind
    Read Only: true
    Allowed Values: [ "", "smart", "constructed" ]
    Kind of inventory being represented.
  • Title: Limit
    The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory.
  • Title: Modified
    Read Only: true
  • Title: Name
    Minimum Length: 1
    Maximum Length: 512
  • Title: Organization
    Organization containing this inventory.
  • Title: Pending deletion
    Read Only: true
    Flag indicating the inventory is being deleted.
  • Title: Prevent instance group fallback
    If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
  • Title: Source vars
    The source_vars for the related auto-created inventory source, special to constructed inventory.
  • Title: Summary fields
    Read Only: true
  • Title: Total groups
    Read Only: true
    Minimum Value: 0
    This field is deprecated and will be removed in a future release. Total number of groups in this inventory.
  • Title: Total hosts
    Read Only: true
    Minimum Value: 0
    This field is deprecated and will be removed in a future release. Total number of hosts in this inventory.
  • Title: Total inventory sources
    Read Only: true
    Minimum Value: 0
    Total number of external inventory sources configured within this inventory.
  • Title: Type
    Read Only: true
  • Title: Update cache timeout
    Minimum Value: 0
    The cache timeout for the related auto-created inventory source, special to constructed inventory
  • Title: Url
    Read Only: true
  • Title: Variables
    Inventory variables in JSON or YAML format.
  • Title: Verbosity
    Minimum Value: 0
    Maximum Value: 2
    The verbosity level for the related auto-created inventory source, special to constructed inventory
Back to Top