Jump to

• Request
• Response

Retrieve an Inventory

get

/api/v2/inventories/{id}/

Make GET request to this resource to retrieve a single inventory record containing the following fields:

• id: Database ID for this inventory. (integer)
• type: Data type for this inventory. (choice)
• url: URL for this inventory. (string)
• related: Data structure with URLs of related resources. (object)
• summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
• created: Timestamp when this inventory was created. (datetime)
• modified: Timestamp when this inventory was last modified. (datetime)
• name: Name of this inventory. (string)
• description: Optional description of this inventory. (string)
• organization: Organization containing this inventory. (id)
• kind: Kind of inventory being represented. (choice)
  • "": Hosts have a direct link to this inventory.
  • 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)
• variables: Inventory variables in JSON or YAML format. (json)
• has_active_failures: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. (boolean)
• total_hosts: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. (integer)
• hosts_with_active_failures: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. (integer)
• total_groups: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. (integer)
• has_inventory_sources: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. (boolean)
• total_inventory_sources: Total number of external inventory sources configured within this inventory. (integer)
• inventory_sources_with_failures: Number of external inventory sources in this inventory with failures. (integer)
• pending_deletion: Flag indicating the inventory is being deleted. (boolean)
• 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)

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : Inventory

Type: object

Show Source

• 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
  Title: Related

  Read Only: true
• 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.

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "has_active_failures":{
            "description":"This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed.",
            "readOnly":true,
            "title":"Has active failures",
            "type":"boolean"
        },
        "has_inventory_sources":{
            "description":"This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources.",
            "readOnly":true,
            "title":"Has inventory sources",
            "type":"boolean"
        },
        "host_filter":{
            "description":"Filter that will be applied to the hosts of this inventory.",
            "title":"Host filter",
            "type":"string",
            "x-nullable":true
        },
        "hosts_with_active_failures":{
            "description":"This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures.",
            "minimum":"0",
            "readOnly":true,
            "title":"Hosts with active failures",
            "type":"integer"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory_sources_with_failures":{
            "description":"Number of external inventory sources in this inventory with failures.",
            "minimum":"0",
            "readOnly":true,
            "title":"Inventory sources with failures",
            "type":"integer"
        },
        "kind":{
            "description":"Kind of inventory being represented.",
            "enum":[
                "",
                "smart",
                "constructed"
            ],
            "title":"Kind",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"Organization containing this inventory.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "pending_deletion":{
            "description":"Flag indicating the inventory is being deleted.",
            "readOnly":true,
            "title":"Pending deletion",
            "type":"boolean"
        },
        "prevent_instance_group_fallback":{
            "description":"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":"Prevent instance group fallback",
            "type":"boolean",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "total_groups":{
            "description":"This field is deprecated and will be removed in a future release. Total number of groups in this inventory.",
            "minimum":"0",
            "readOnly":true,
            "title":"Total groups",
            "type":"integer"
        },
        "total_hosts":{
            "description":"This field is deprecated and will be removed in a future release. Total number of hosts in this inventory.",
            "minimum":"0",
            "readOnly":true,
            "title":"Total hosts",
            "type":"integer"
        },
        "total_inventory_sources":{
            "description":"Total number of external inventory sources configured within this inventory.",
            "minimum":"0",
            "readOnly":true,
            "title":"Total inventory sources",
            "type":"integer"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "variables":{
            "description":"Inventory variables in JSON or YAML format.",
            "title":"Variables",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name",
        "organization"
    ],
    "type":"object"
}

Back to Top