The instance metadata service (IMDS) provides information about a running virtual machine (VM) instance, including instance metadata, labels, resources, user and network data.Documentation Index
Fetch the complete documentation index at: https://docs.nebius.com/llms.txt
Use this file to discover all available pages before exploring further.
How to access IMDS
IMDS is available only from within a VM instance itself. Once you connect to a VM, use the following base URL to request metadata:GET method and include the Metadata: true header. Requests without this header return 400 Bad Request. Requests that use any method other than GET return 405 Method Not Allowed.
Metadata updates
IMDS provides metadata captured at VM start time. The following endpoints are not refreshed in real time:instance-dataparent-datanetwork-datauser-data
Unlike the other endpoints,
instance-events provides live updates and does not require a VM restart. A maintenance event may take up to five minutes to appear in the response.Example requests
The following examples show how to retrieve different types of metadata from IMDS.Getting all instance metadata
To get all available instance metadata in JSON format, run:labels is always returned as a JSON object. If no labels were set, IMDS returns an empty object.
The following fields are optional and are returned only when available for the VM:
hostnameservice_account_idgpu_cluster_idinfiniband_fabricinfiniband_topology_pathnvl_instance_group_id
Getting a specific metadata field
To get a specific metadata field as plain text, run:Getting instance labels
To get all labels for the VM, run:Getting parent resource metadata
To get parent resource metadata in JSON format, run:To access
parent-data, the VM must have an attached service account with permissions to read the parent resource metadata. Otherwise, the request returns 403 Forbidden.Getting user data
To get the user data that was provided when the VM was created, run:Getting network data
To get the VM network data, run:Getting service account information
To get information about the service account attached to the VM and its IAM token, run:Getting maintenance events
To check if a maintenance event is scheduled for the VM, run:Request throttling
Nebius AI Cloud applies throttling to IMDS requests on a per-instance basis to reduce accidental overload and abuse:- 10 requests per second for regular requests
- 20 requests per second for burst requests
429 Too Many Requests.
Status codes
| HTTP status code | Description |
|---|---|
200 OK | The request succeeded. |
400 Bad Request | The Metadata: true header is missing or invalid. |
403 Forbidden | The VM does not have permission to access the requested resource. |
404 Not Found | The requested resource or field does not exist. |
405 Method Not Allowed | The request used a method other than GET. |
429 Too Many Requests | The request rate limit was exceeded. Retry the request. |
500 Internal Server Error | The server encountered an error. Retry the request. |
501 Not Implemented | The requested feature is not implemented. |
503 Service Unavailable | The service is temporarily unavailable, or the request could not be attributed to this VM. Retry the request. |