Method: assets.list

Lists assets with time and resource types and returns paged results in response.

HTTP request

GET https://cloudasset.googleapis.com/v1/{parent=*/*}/assets

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the organization, folder, or project the assets belong to. Format: "organizations/[organization-number]" (such as "organizations/123"), "projects/[project-id]" (such as "projects/my-project-id"), "projects/[project-number]" (such as "projects/12345"), or "folders/[folder-number]" (such as "folders/12345").

Authorization requires one or more of the following IAM permissions on the specified resource parent:

  • cloudasset.assets.listResource
  • cloudasset.assets.listIamPolicy
  • cloudasset.assets.listOrgPolicy
  • cloudasset.assets.listAccessPolicy
  • cloudasset.assets.listOSInventories

Query parameters

Parameters
readTime

string (Timestamp format)

Timestamp to take an asset snapshot. This can only be set to a timestamp between the current time and the current time minus 35 days (inclusive). If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
assetTypes[]

string

A list of asset types to take a snapshot for. For example: "compute.googleapis.com/Disk".

Regular expression is also supported. For example:

  • "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
  • ".*Instance" snapshots resources whose asset type ends with "Instance".
  • ".*Instance.*" snapshots resources whose asset type contains "Instance".

See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

If specified, only matching assets will be returned, otherwise, it will snapshot all asset types. See Introduction to Cloud Asset Inventory for all supported asset types.
contentType

enum (ContentType)

Asset content type. If not specified, no content but the asset name will be returned.
pageSize

integer

The maximum number of assets to be returned in a single response. Default is 100, minimum is 1, and maximum is 1000.
pageToken

string

The nextPageToken returned from the previous ListAssetsResponse, or unspecified for the first ListAssetsRequest. It is a continuation of a prior assets.list call, and the API should return the next page of assets.
relationshipTypes[]

string

A list of relationship types to output, for example: INSTANCE_TO_INSTANCEGROUP. This field should only be specified if contentType=RELATIONSHIP. * If specified: it snapshots specified relationships. It returns an error if any of the [relationshipTypes] doesn't belong to the supported relationship types of the [assetTypes] or if any of the [assetTypes] doesn't belong to the source types of the [relationshipTypes]. * Otherwise: it snapshots the supported relationships for all [assetTypes] or returns an error if any of the [assetTypes] has no relationship support. An unspecified asset types field means all supported assetTypes. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.

Request body

The request body must be empty.

Response body

assets.list response.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "readTime": string,
  "assets": [
    {
      object (Asset)
    }
  ],
  "nextPageToken": string
}
Fields
readTime

string (Timestamp format)

Time the snapshot was taken.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
assets[]

object (Asset)

Assets.
nextPageToken

string

Token to retrieve the next page of results. It expires 72 hours after the page token for the first page is generated. Set to empty if there are no remaining results.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.