Home / Search/ Language Reference/ Virtual Tables/$vt_object_list

$vt_object_list

The $vt_object_list virtual table retrieves the metadata of the specified Dataset.

Deprecated Feature

Cribl is deprecating this feature in preparation for a different solution. We’ll remove it in a future release.

Please continue to report issues through normal Cribl support channels, but assistance for deprecated features might be limited.

// returns those cribl_search_sample events that contain Cribl Search metadata
dataset="$vt_object_list" datasetId="cribl_search_sample"

Purpose

Use $vt_object_list to find out which fields contain Cribl Search metadata (for example, generated by the .generate metadata command). Searching fields described by metadata can be more efficient.

Permissions

Search Member TypePermissions
AdminCan see the metadata of all Datasets in their organization.
EditorCan see the metadata of only those Datasets that they created themselves or that were shared with them.
UserCan see the metadata of only those Datasets that were shared with them.

Syntax

dataset="$vt_object_list" datasetId="DatasetId"

Parameters

NameTypeRequiredDescription
DatasetIdstringThe ID of the Dataset that you want to check for metadata. You can find the ID of every Dataset in Data > Datasets.

Returns

Returns those events that contain the Cribl Search metadata field, statistics. Expand the statistics field to see the collected metadata.

Examples

Show those cribl_search_sample events that contain Cribl Search metadata.

dataset="$vt_object_list" datasetId="cribl_search_sample"