Update an Inventory

patch

/api/v2/inventories/{id}/

Make a PUT or PATCH request to this resource to update this inventory. The following fields may be modified:

  • name: Name of this inventory. (string, required)
  • description: Optional description of this inventory. (string, default="")
  • organization: Organization containing this inventory. (id, required)
  • kind: Kind of inventory being represented. (choice)
    • "": Hosts have a direct link to this inventory. (default)
    • smart: Hosts for inventory generated using the host_filter property.
    • constructed: Parse list of source inventories with the constructed inventory plugin.
  • host_filter: Filter that will be applied to the hosts of this inventory. (string, default="")
  • 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)

For a PATCH request, include only the fields that are being modified.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : Inventory
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: Host filter
    Filter that will be applied to the hosts of this inventory.
  • 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
    Allowed Values: [ "", "smart", "constructed" ]
    Kind of inventory being represented.
  • 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: 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: Url
    Read Only: true
  • Title: Variables
    Inventory variables in JSON or YAML format.
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : Inventory
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: Host filter
    Filter that will be applied to the hosts of this inventory.
  • 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
    Allowed Values: [ "", "smart", "constructed" ]
    Kind of inventory being represented.
  • 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: 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: Url
    Read Only: true
  • Title: Variables
    Inventory variables in JSON or YAML format.
Back to Top