Get Version

Authorizations

Authorization

string

header

required

The Authorization header expects a Bearer token.

Query Parameters

type

enum<string>

default:AGENT_UNDEFINED

Type of the agent. Must be O11Y_AGENT (1).

AGENT_UNDEFINED: Default undefined state.
O11Y_AGENT: Observability agent type.

Available options:

AGENT_UNDEFINED,

O11Y_AGENT

agentVersion

string

Current version of the agent software.

updaterVersion

string

Version of the updater component.

parentId

string

Parent identifier for the VM

instanceId

string

Unique identifier for the instance where agent is running.

osInfo.name

string

Operating system name and version. Example: "Ubuntu 22.04.4 LTS"

osInfo.uname

string

Detailed system information from uname command.

Example:

Linux computeimage-abcdef 6.5.0-44-generic #44~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Tue Jun 18 14:36:16 UTC 2 x86_64 x86_64 x86_64 GNU/Linux

osInfo.architecture

string

System architecture.

agentState

enum<string>

default:STATE_UNDEFINED

Current operational state of the agent.

STATE_UNDEFINED: Default undefined state.
STATE_HEALTHY: Agent is functioning normally.
STATE_ERROR: Agent is in error state.

Available options:

STATE_UNDEFINED,

STATE_HEALTHY,

STATE_ERROR

agentUptime

string

Time duration since the agent started.

systemUptime

string

Total system uptime.

updaterUptime

string

Time duration since the updater component started.

agentStateMessages

string[]

Status messages from the agent describing its current state.

lastUpdateError

string

Description of the last update failure, if any.

mk8sClusterId

string

Managed Kubernetes cluster identifier, if applicable.

modulesHealth.process.state

enum<string>

default:STATE_UNDEFINED

Current operational state of the module.

STATE_UNDEFINED: Default undefined state.
STATE_HEALTHY: Agent is functioning normally.
STATE_ERROR: Agent is in error state.

Available options:

STATE_UNDEFINED,

STATE_HEALTHY,

STATE_ERROR

modulesHealth.process.messages

string[]

Status messages describing the module's state.

modulesHealth.gpuPipeline.state

enum<string>

default:STATE_UNDEFINED

Current operational state of the module.

STATE_UNDEFINED: Default undefined state.
STATE_HEALTHY: Agent is functioning normally.
STATE_ERROR: Agent is in error state.

Available options:

STATE_UNDEFINED,

STATE_HEALTHY,

STATE_ERROR

modulesHealth.gpuPipeline.messages

string[]

Status messages describing the module's state.

modulesHealth.cpuPipeline.state

enum<string>

default:STATE_UNDEFINED

Current operational state of the module.

STATE_UNDEFINED: Default undefined state.
STATE_HEALTHY: Agent is functioning normally.
STATE_ERROR: Agent is in error state.

Available options:

STATE_UNDEFINED,

STATE_HEALTHY,

STATE_ERROR

modulesHealth.cpuPipeline.messages

string[]

Status messages describing the module's state.

modulesHealth.ciliumPipeline.state

enum<string>

default:STATE_UNDEFINED

Current operational state of the module.

STATE_UNDEFINED: Default undefined state.
STATE_HEALTHY: Agent is functioning normally.
STATE_ERROR: Agent is in error state.

Available options:

STATE_UNDEFINED,

STATE_HEALTHY,

STATE_ERROR

modulesHealth.ciliumPipeline.messages

string[]

Status messages describing the module's state.

modulesHealth.vmappsPipeline.state

enum<string>

default:STATE_UNDEFINED

Current operational state of the module.

STATE_UNDEFINED: Default undefined state.
STATE_HEALTHY: Agent is functioning normally.
STATE_ERROR: Agent is in error state.

Available options:

STATE_UNDEFINED,

STATE_HEALTHY,

STATE_ERROR

modulesHealth.vmappsPipeline.messages

string[]

Status messages describing the module's state.

modulesHealth.commonServiceLogsPipeline.state

enum<string>

default:STATE_UNDEFINED

Current operational state of the module.

STATE_UNDEFINED: Default undefined state.
STATE_HEALTHY: Agent is functioning normally.
STATE_ERROR: Agent is in error state.

Available options:

STATE_UNDEFINED,

STATE_HEALTHY,

STATE_ERROR

modulesHealth.commonServiceLogsPipeline.messages

string[]

Status messages describing the module's state.

modulesHealth.vmServiceLogsPipeline.state

enum<string>

default:STATE_UNDEFINED

Current operational state of the module.

STATE_UNDEFINED: Default undefined state.
STATE_HEALTHY: Agent is functioning normally.
STATE_ERROR: Agent is in error state.

Available options:

STATE_UNDEFINED,

STATE_HEALTHY,

STATE_ERROR

modulesHealth.vmServiceLogsPipeline.messages

string[]

Status messages describing the module's state.

modulesHealth.computeGpuLogsPipeline.state

enum<string>

default:STATE_UNDEFINED

Current operational state of the module.

STATE_UNDEFINED: Default undefined state.
STATE_HEALTHY: Agent is functioning normally.
STATE_ERROR: Agent is in error state.

Available options:

STATE_UNDEFINED,

STATE_HEALTHY,

STATE_ERROR

modulesHealth.computeGpuLogsPipeline.messages

string[]

Status messages describing the module's state.

modulesHealth.journaldPipeline.state

enum<string>

default:STATE_UNDEFINED

Current operational state of the module.

STATE_UNDEFINED: Default undefined state.
STATE_HEALTHY: Agent is functioning normally.
STATE_ERROR: Agent is in error state.

Available options:

STATE_UNDEFINED,

STATE_HEALTHY,

STATE_ERROR

modulesHealth.journaldPipeline.messages

string[]

Status messages describing the module's state.

modulesHealth.ncclMetricsPipeline.state

enum<string>

default:STATE_UNDEFINED

Current operational state of the module.

STATE_UNDEFINED: Default undefined state.
STATE_HEALTHY: Agent is functioning normally.
STATE_ERROR: Agent is in error state.

Available options:

STATE_UNDEFINED,

STATE_HEALTHY,

STATE_ERROR

modulesHealth.ncclMetricsPipeline.messages

string[]

Status messages describing the module's state.

cloudInitStatus

string

Status of cloud initialization process.

instanceIdUsedFallback

boolean

Indicates if a fallback method was used to determine instance_id.

lastAgentLogs

string

Recent agent log entries for diagnostic purposes.

gpuModel

string

Model of the GPU used in the system.

gpuNumber

integer<int32>

Number of GPUs available in the system.

dcgmVersion

string

Version of the DCGM (Data Center GPU Manager) used.

healthcheckLogs.directorySizeBytes

string<int64>

Size of the healthcheck directory in bytes.

healthcheckLogs.mountpointTotalBytes

string<int64>

Total size of the healthcheck mountpoint in bytes.

lastSeenConfigVersion

string<uint64>

Largest config_version this agent has already accepted; 0 if none.

Response

200 - application/json

A successful response.

Response message for GetVersion RPC containing required action for the agent.

action

enum<string>

default:ACTION_UNDEFINED

Action to be taken by the agent based on version check.

ACTION_UNDEFINED: Default undefined action.
NOP: No operation needed.
UPDATE: Update to new version required.
RESTART: Agent restart required.

Available options:

ACTION_UNDEFINED,

NOP,

UPDATE,

RESTART

configVersion

string<uint64>

Version of the rollout state this response was built from. Agent echoes it back as last_seen_config_version on the next request.

featureFlags

object

Feature flags for the agent. Keys are UPPER_CASE flag names, values are flag values (typically "true"/"false"). When feature_flags_unavailable is true the agent must ignore this field and keep its current flag set unchanged.

Show child attributes

featureFlagsUnavailable

boolean

True when the server could not load feature-flag state. The agent must keep its current flag set instead of treating an empty feature_flags map as "clear all". The default value of false means feature_flags is authoritative — including legitimately empty.

nop

object

Parameters when no operation is required.

restart

object

Parameters for agent restart action.

update

object

Parameters for agent update action.

Show child attributes

Developer tools in Nebius AI Cloud

CLI

Terraform provider

REST API

gRPC API

Agent Resources

Authorizations

Query Parameters

Response