Contact UsGet started

Metadata folders

Written by
Updated at March 7, 2025

The VM instance metadata service provides access to the following metadata folders:

Folder Path
computeMetadata /computeMetadata/v1/
user-data /latest/user-data/

computeMetadata

The computeMetadata folder contains the following main keys:

Key name (path)

Description

Value example

instance/attributes/enable-oslogin

Key responsible for access to the VM instance via OS Login. Possible values:
- true: Access enabled
- false: Access disabled.

true

instance/attributes/install-unified-agent

Key responsible for installing the Unified Agent on the VM instance. Possible values:
- 1: Agent installed
- 0: Agent not installed.

0

instance/attributes/serial-port-enable

Key responsible for access to the VM instance via the serial console. Possible values:
- 1: Access enabled
- 0: Access disabled.

0

instance/description

VM description.

VM description

instance/hostname

Full internal VM name (FQDN).

my-vm.ru-central1.internal

instance/id

VM ID.

epdhfouo8bgq********

instance/maintenance-event

Key indicating whether the VM instance maintenance event has occurred.

NONE

instance/name

VM name.

my-vm-name

instance/zone

Availability zone ID in projects/<cloud-id>/zones/<zone-id> format.

projects/b1g3o1qx3ra2********/zones/ru-central1-d

instance/disks/

List of VM disk indexes.

0/

instance/disks/<disk_index>/device-name

Disk ID.

epds95ahfikq********

instance/disks/<disk_index>/mode

Disk operating mode.

READ_WRITE

instance/disks/<disk_index>/type

Disk type.

PERSISTENT

instance/disks/<disk_index>/index

Index in the list of VM disk indexes.

0

instance/network-interfaces/

List of indexes of the VM instance network interfaces.

0/

instance/network-interfaces/<interface_index>/ip

Internal IPv4 address of the VM instance network interface.

10.128.0.27

instance/network-interfaces/<interface_index>/mac

MAC address of the VM instance network interface.

d0:0d:12:2f:84:2e

instance/network-interfaces/<interface_index>/network

ID of the subnet the network interface is connected to.

e2lqsms4cdl3********

instance/network-interfaces/<interface_index>/access-configs/<interface_index>/external-ip

Public IP address of the VM instance network interface.

178.1**.2**.123

instance/network-interfaces/<interface_index>/access-configs/<interface_index>/type

Type of external connectivity of the VM instance network interface.

ONE_TO_ONE_NAT

instance/service-accounts/

Key indicating whether a service account is linked to the VM instance. If a service account is not linked, the key does not return anything.

default/

instance/service-accounts/default/token

Service account's IAM token in JSON format.

 

\{"access_token":"t1.9euelZ*********dXkMXAQ",
"expires_in":42617,"token_type":"Bearer"\}

instance/vendor/cloud-id

ID of the cloud the VM instance is created in.

b1gia87mbaom********

instance/vendor/folder-id

ID of the folder the VM instance is created in.

b1gt6g8ht345********

instance/vendor/identity/document

Identity document in JSON format containing information about the VM instance ID (instanceId), ID of the image (imageId) the VM instance was created from, and additional info about the VM instance image.

 

\{"instanceId":"epdhfouo8bgq********",
"productCodes":null,"imageId":"fd8a1rd5b389********",
"productIds":["f2ev7krjsaqc********","f2eokm18lqng********"],
"createdAt":"2024-05-09T20:47:02Z","version":"2023-03-01"\}

instance/vendor/identity/base64

Cryptographic signature of the identity document in Base64 format.

U9UfLdKb91Zd********0bBs8ta0g==

instance/vendor/identity/dsa

Cryptographic signature of the identity document in DSA format.

 

-----BEGIN PKCS7-----MIIB+QYJKoZIhvc
******/RaHgWi0=-----END PKCS7-----

instance/vendor/labels

List of label keys linked to the VM instance.

env

instance/vendor/labels/<label_key>

Value of selected label key from the list.

prod

instance/vendor/environment

Cloud region.

ru-central1

yandex/folder-id

ID of the folder the VM instance was created in.

b1gt6g8ht345********

user-data

The user-data folder contains no separate keys, so the data is provided all at once when accessing the root key of the /latest/user-data/ folder.

This folder stores the metadata specified by the user when creating or modifying the VM instance. This information is received by the cloud-init process initiated when the VM instance starts.

To get information from this folder, you need to run a request.

Alert

All data in the user-data metadata folder will be publicly available to any user with terminal access to the VM instance.

See also

Previous
Overview
Next
Keys processed in public images