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
- application/json
Path Parameters
Root Schema : Inventory
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
has_active_failures:
boolean
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. -
has_inventory_sources:
boolean
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. -
host_filter:
string
Title:
Host filter
Filter that will be applied to the hosts of this inventory. -
hosts_with_active_failures:
integer
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. -
id:
integer
Title:
ID
Read Only:true
-
inventory_sources_with_failures:
integer
Title:
Inventory sources with failures
Read Only:true
Minimum Value:0
Number of external inventory sources in this inventory with failures. -
kind:
string
Title:
Kind
Allowed Values:[ "", "smart", "constructed" ]
Kind of inventory being represented. -
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
-
organization(required):
integer
Title:
Organization
Organization containing this inventory. -
pending_deletion:
boolean
Title:
Pending deletion
Read Only:true
Flag indicating the inventory is being deleted. -
prevent_instance_group_fallback:
boolean
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. - related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
total_groups:
integer
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. -
total_hosts:
integer
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. -
total_inventory_sources:
integer
Title:
Total inventory sources
Read Only:true
Minimum Value:0
Total number of external inventory sources configured within this inventory. -
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
variables:
string
Title:
Variables
Inventory variables in JSON or YAML format.
Response
Supported Media Types
- application/json
200 Response
Root Schema : Inventory
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
has_active_failures:
boolean
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. -
has_inventory_sources:
boolean
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. -
host_filter:
string
Title:
Host filter
Filter that will be applied to the hosts of this inventory. -
hosts_with_active_failures:
integer
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. -
id:
integer
Title:
ID
Read Only:true
-
inventory_sources_with_failures:
integer
Title:
Inventory sources with failures
Read Only:true
Minimum Value:0
Number of external inventory sources in this inventory with failures. -
kind:
string
Title:
Kind
Allowed Values:[ "", "smart", "constructed" ]
Kind of inventory being represented. -
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
-
organization(required):
integer
Title:
Organization
Organization containing this inventory. -
pending_deletion:
boolean
Title:
Pending deletion
Read Only:true
Flag indicating the inventory is being deleted. -
prevent_instance_group_fallback:
boolean
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. - related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
total_groups:
integer
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. -
total_hosts:
integer
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. -
total_inventory_sources:
integer
Title:
Total inventory sources
Read Only:true
Minimum Value:0
Total number of external inventory sources configured within this inventory. -
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
variables:
string
Title:
Variables
Inventory variables in JSON or YAML format.