--- title: "Get information about a node" method: GET path: "/nodes/{nodeId}" tags: ["Nodes"] --- # Get information about a node `GET /nodes/{nodeId}` Get details about a given node ## Path parameters - `nodeId` string, uuid (or "root"), required ## Query parameters - `include` string, comma-separated list ## Response `200` Nodes - object - `result` 'success' | 'error', required — Result of the request - `action` 'nodeDetails', required — The id of the action - `data` object, required — Information about the node - `nodes` NodeFull[], required - `id` string, uuid (or "root"), required — Unique id of the node - `hostname` string, required — Fully qualified name of the node - `status` 'pending' | 'accepted' | 'deleted', required — Status of the node - `architectureDescription` string — Information about CPU architecture (32/64 bits) - `description` string — A human intended description of the node - `ipAddresses` string[], required — IP addresses of the node (IPv4 and IPv6) - `lastRunDate` string, date-time — Date and time of the latest run, if one is available (node time). Up to API v11, format was: "YYYY-MM-dd HH:mm" - `acceptanceDate` string, date-time — Date and time of the acceptance of the node into Rudder. - `lastInventoryDate` string, date-time — Date and time of the latest generated inventory, if one is available (node time). Up to API v11, format was: "YYYY-MM-dd HH:mm" - `machine` object — Information about the underlying machine - `id` string — Rudder unique identifier for the machine - `type` 'Physical' | 'Virtual' — Type of the machine - `provider` string — In the case of VM, the VM technology - `manufacturer` string — Information about machine manufacturer - `serialNumber` string — If available, a unique identifier provided by the machine - `os` object — Information about the operating system - `type` 'Windows' | 'Linux', required — Family of the OS - `name` string, required — Operating system name (distribution on Linux, etc.) - `version` string, required — OS version - `fullName` string, required — Full operating system name - `servicePack` string — If relevant, the service pack of the OS - `kernelVersion` string, required — Version of the OS kernel - `managementTechnology` object[], required — Management agents running on the node - `name` string, required — Agent name - `version` string — Agent version - `capabilities` string[], required — List of agent capabilities - `nodeKind` string, required — kind of node for the management engine, like `root`, `relay`, `node`, `root-component` - `rootComponents` string[] — Roles fulfilled by the agent - `policyServerId` string, uuid (or "root"), required — Rudder policy server managing the node - `properties` object[], required — Node properties (either set by user or filled by third party sources) - `name` string, required — Property name - `value` string, string or JSON, required — Property value (can be a string or JSON object) - `policyMode` 'enforce' | 'audit' | 'default' — Rudder policy mode for the node (`default` follows the global configuration) - `ram` integer — Size of RAM in bytes - `timezone` object - `name` string, required — Timezone name - `offset` string, +/-difference, required — Timezone offset to UTC - `accounts` string[] — User accounts declared in the node - `bios` object — BIOS information - `name` string — BIOS name - `version` string — BIOS version - `editor` string — BIOS editor - `quantity` integer — Number of BIOS on the machine - `releaseDate` string, date-time — Release date of the BIOS (with format `yyyy-MM-dd'T'HH:mm:ssZZ`) - `description` string — System provided description of the BIOS (long name) - `controllers` object[] — Physical controller information - `name` string — Controller name - `type` string — Controller type - `quantity` integer — Quantity of that controller - `description` string — System provided description of the controller - `manufacturer` string — Controller manufacturer - `environmentVariables` object[] — Environment variables defined on the node in the context of the agent - `name` string — Environment variable name - `value` string — Environment variable value - `instanceId` string — The Rudder instance unique identifier on which that node lives - `fileSystems` object[] — File system declared on the node - `name` string — Type of file system (`ext4`, `swap`, etc.) - `mountPoint` string — Mount point - `description` string — Description of the file system - `fileCount` integer — Number of files - `freeSpace` integer — Free space remaining in bytes - `totalSpace` integer — Total space in bytes - `managementTechnologyDetails` object — Additional information about management technology - `cfengineKeys` string[] — Certificates used by the agent - `cfengineUser` string — Local user account used by the agent - `scheduleOverride` object — Node agent run specific run schedule - `runInterval` string — duration of run interval, formatted with a time unit - `firstRun` string — time of the first run in HH:mm format - `splayTime` string — duration of the configured splay time with a time unit - `memories` object[] — Memory slots - `name` string — Name of the memory slot or memory module - `speed` integer — Memory speed (frequency) - `type` string — Memory slot type - `caption` string — Manufacturer provided information about the module - `quantity` integer — Number of modules in that slot - `capacity` integer — Size of modules in bytes - `slotNumber` integer — Slot number - `description` string — System provided description - `serialNumber` string — Serial number of the module - `networkInterfaces` object[] — Detailed information about registered network interfaces on the node - `name` string — Interface name (for ex "eth0") - `mask` string[] - `type` string — Information about the type of network interface - `speed` string — Information about synchronization speed - `status` string — network interface status (enabled or not, up or down) - `dhcpServer` string — DHCP server managing that network interface - `macAddress` string — MAC address of the network interface - `ipAddresses` string[] — IP addresses of the network interface - `ports` object[] — Physical port information objects - `name` string — Port name - `type` string — Port type - `quantity` integer — Quantity of similar ports - `description` string — System provided description of the port - `processes` object[] — Process running (at inventory time) - `pid` integer — PID of the process - `tty` string — TTY to which the process is - `name` string — Process name - `user` string — User account who started the process - `started` string, date-time (without tz) — Started date and time of the process - `memory` number, float — Memory allocated to the process (at inventory time) - `virtualMemory` integer — Virtual memory allocated to the process (at inventory time) - `cpuUsage` integer — CPU used by the process (at inventory time) - `description` string — System provided description about the process - `processors` object[] — CPU information - `name` string — CPU name - `arch` string — CPU architecture - `model` integer — CPU model - `familyName` string — CPU family - `core` integer — Number of core for that CPU - `speed` integer — Speed (frequency) of the CPU - `thread` integer — Number of thread by core for the CPU - `stepping` integer — Stepping or power management information - `manufacturer` string — CPU manufacturer - `quantity` integer — Number of CPU with these features - `cpuid` string — Identifier of the CPU - `externalClock` string — External clock used by the CPU - `description` string — System provided description of the CPU - `slots` object[] — Physical extension slot information - `name` string — Slot name or identifier - `status` string — Slot status (used, powered, etc) - `quantity` integer — Quantity of similar slots - `description` string — System provided description of the slots - `software` object[] — Software installed on the node (can have thousands items) - `name` string — Name of the software (as reported by the node) - `version` string — Version of the software - `editor` string — Editor of the software - `description` string — A description of the software - `releaseDate` string, date-time — Release date of the software - `license` object — Information about the license - `oem` string — Is this an OEM license (and information) - `name` string — License name - `productId` string — License product identifier - `productKey` string — License key - `description` string — License description - `expirationDate` string, date-time — License expiration date - `softwareUpdate` object[] — Software that can be updated on that machine - `name` string — name of software that can be updated - `version` string — available version for software - `arch` string — CPU architecture of the update - `from` string — tool that discovered that update - `kind` 'none' | 'security' | 'defect' | 'enhancement' | 'other' — if available, kind of patch provided by that update, else none - `source` string — information about the source providing that update - `description` string — details about the content of the update, if available - `severity` 'critical' | 'high' | 'moderate' | 'low' | 'other' — if available, the severity of the update - `ids` string[] - `sound` object[] — Sound card information - `name` string — Sound card name - `quantity` integer — Quantity of similar sound cards - `description` string — System provided description of the sound card - `storage` object[] — Storage (disks) information objects - `name` string — Storage name - `type` string — Storage type - `size` integer — Storage size in bytes - `model` string — Storage model - `firmware` string — Storage firmware information - `quantity` integer — Quantity of similar storage - `description` string — System provided information about the storage - `manufacturer` string — Storage manufacturer - `serialNumber` string — Storage serial number - `videos` object[] — Video card information - `name` string — Video card name - `memory` string — Quantity of memory for that video card in bytes - `chipset` string — information about video card chipset - `quantity` integer — Quantity of similar video cards - `resolution` string — Resolution used by that video card at inventory time - `description` string — System provided description for that video card - `virtualMachines` object[] — Hosted virtual machine information - `name` string — Name of the hosted virtual machine - `type` string — Type of the hosted virtual machine - `uuid` string — Unique identifier of the hosted virtual machine - `vcpu` string — Number of virtual CPU allocated to the hosted virtual machine - `owner` string — Owner of the hosted virtual machine - `status` string — Status (up, starting, etc) of the hosted virtual machine - `memory` string — Memory allocated to the hosted virtual machine - `subsystem` string — Technology of the hosted virtual machine - `description` string — System provided description of the hosted virtual machine --- [API](https://skmtc.net/rudder/apis/rudder-api.md) · [All operations](https://skmtc.net/rudder/apis/rudder-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rudder/rudder-api/revisions/eab988254fba/schema)