Method: projects.locations.instances.inventories.get

Get inventory data for the specified VM instance. If the VM has no associated inventory, the message NOT_FOUND is returned.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. API resource name for inventory resource.

Format: projects/{project}/locations/{location}/instances/{instance}/inventory

For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.

Query parameters


enum (InventoryView)

Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Inventory.

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • osconfig.inventories.get

For more information, see the IAM d