---
title: "Get detailed metadata for a Worker, Edge, or Outpost Node"
method: GET
path: "/products/{product}/workers/{id}"
tags: ["workers"]
---

# Get detailed metadata for a Worker, Edge, or Outpost Node

`GET /products/{product}/workers/{id}`

Get detailed metadata for the specified Worker, Edge, or Outpost Node for the specified Cribl product.

## Path parameters

- `product` 'stream' | 'edge' | 'outpost', required
- `id` string, required

## Response `200`

The requested MasterWorkerEntry object in a single-item list.

- CountedMasterWorkerEntry
  - `count` integer, required — number of items present in the items array
  - `items` MasterWorkerEntry[], required — List of items in this response.
    - `connectionProtocol` 'tcp' | 'tls' | 'http2'
    - `deployable` boolean — If <code>true</code>, the node can receive configuration deployments. Otherwise, <code>false</code>.
    - `disconnected` boolean — If <code>true</code>, the node is disconnected from the Leader. Otherwise, <code>false</code>.
    - `firstMsgTime` integer, required — Timestamp (in Unix time) when the Leader first received a message from the node.
    - `group` string, required — The <code>id</code> of the Worker Group, Edge Fleet, or Outpost Group that contains the node.
    - `id` string, required — Unique identifier for the node.
    - `info` NodeProvidedInfo, required
      - `apiPort` integer — API port exposed by the node.
      - `apiScheme` 'http' | 'https'
      - `architecture` string, required — CPU architecture.
      - `aws` AwsTypeHeartbeatMetadata
        - `enabled` boolean, required — If <code>true</code>, the AWS metadata collector is enabled on the node. Otherwise, <code>false</code>.
        - `instanceId` string, required — AWS EC2 instance ID.
        - `region` string, required — AWS region name.
        - `tags` TagsMapHeartbeatMetadata — String-keyed tag map. Each property name is a tag key and the corresponding value is the tag's string value.
        - `type` string, required — AWS EC2 instance type.
        - `zone` string, required — AWS availability zone name.
      - `azure` AzureTypeHeartbeatMetadata
        - `enabled` boolean, required — If <code>true</code>, the Azure metadata collector is enabled on the node. Otherwise, <code>false</code>.
        - `hostname` string — Azure VM hostname.
        - `instanceId` string — Azure instance ID.
        - `name` string — Azure VM name.
        - `region` string — Azure location or region.
        - `resourceGroup` string — Azure resource group name.
        - `subscriptionId` string — Azure subscription ID.
        - `tags` TagsMapHeartbeatMetadata — String-keyed tag map. Each property name is a tag key and the corresponding value is the tag's string value.
        - `type` string — Azure VM size or instance type.
        - `vmId` string — Azure VM ID.
        - `zone` string — Azure availability zone.
      - `conn_ip` string — Remote <code>ip:port</code> for the worker socket.
      - `cpus` integer, required — Number of CPU cores available on the node.
      - `cribl` HBCriblInfo, required
        - `config` object, required — Configuration bundle and policy revision metadata for the node.
          - `apiCredentialsRev` string — Current API credentials revision string. Only used in leader <> leader universal subscription.
          - `featuresRev` string — Feature flags or feature revision string for the bundle.
          - `hbPeriodSeconds` integer — Worker-to-Leader heartbeat interval, in seconds.
          - `logStreamEnv` string — GitOps or LogStream environment label associated with the bundle.
          - `policyRev` string — Current policies revision string.
          - `teamsRev` string — Current teams revision string. Only used in leader <> leader universal subscription.
          - `usersRev` string — Current users revision string. Only used in leader <> leader universal subscription.
          - `version` string — Configuration bundle version.
        - `deploymentId` string — Unique identifier for the deployment assigned for the node.
        - `disableSNIRouting` boolean — If <code>true</code>, SNI-based routing to the Leader is disabled for the connection.
        - `distMode` 'edge' | 'managed-edge' | 'master' | 'outpost' | 'search-supervisor' | 'single' | 'worker', required — Distributed deployment mode for the instance.
        - `edgeNodes` integer — Count of Edge nodes reported in the Leader heartbeat.
        - `group` string, required — Worker Group or Edge Fleet name.
        - `guid` string, required — Unique instance identifier for the Cribl node.
        - `installType` string — Value of the <code>CRIBL_INSTALL_TYPE</code> environment variable, relayed for upgrade decisions (since 4.5.0).
        - `lookupVersions` LookupVersions — Objects that map Lookup files to deployment versions.
        - `master` HBLeaderInfo — Connection parameters for the Leader Node, as reported in a Worker heartbeat.
          - `host` string, required — Leader hostname or IP address.
          - `port` integer, required — Leader TCP port.
          - `servername` string — TLS server name (SNI) for the Leader connection.
          - `tls` boolean — If <code>true</code>, TLS is enabled for the Leader connection.
        - `overlayId` string — Currently active overlay identifier on the node. Omitted if no overlay is active.
        - `pid` integer — The process ID.
        - `socksEnabled` boolean — If <code>true</code>, SOCKS proxy connectivity is enabled for the node.
        - `startTime` integer, required — Timestamp (in Unix time) when the Cribl server process started, in milliseconds.
        - `tags` string[] — Tags from the node.
        - `version` string — Cribl software version string for the node.
      - `env` object, required — Environment variables reported by the node.
      - `freeDiskSpace` integer — Free disk space on the node, in bytes.
      - `hostOs` HostOsTypeHeartbeatMetadata
        - `addresses` string[], required — Network addresses reported by the host operating system.
        - `enabled` boolean, required — If <code>true</code>, the host operating system metadata collector is enabled on the node. Otherwise, <code>false</code>.
        - `id` string, required — Host operating system distribution name.
        - `version` string, required — Host operating system version.
      - `hostname` string, required — Hostname reported by the node.
      - `isCaptain` boolean — If <code>true</code>, the node considers itself the elected captain for its group. Otherwise, <code>false</code>.
      - `isSaasWorker` boolean — If <code>true</code>, the node runs in Cribl.Cloud. Otherwise, <code>false</code>.
      - `kube` KubeTypeHeartbeatMetadata
        - `enabled` boolean, required — If <code>true</code>, the Kubernetes metadata collector is enabled on the node. Otherwise, <code>false</code>.
        - `namespace` string, required — Kubernetes Namespace name.
        - `node` string, required — Kubernetes Node name.
        - `owner` OwnerTypeHeartbeatMetadataKube
          - `kind` string, required — Kubernetes owner resource kind.
          - `name` string, required — Kubernetes owner resource name.
        - `pod` string, required — Kubernetes Pod name.
        - `source` string, required — Kubernetes config source.
      - `localTime` integer — Local timestamp (in Unix time) on the node, in milliseconds.
      - `metadata` HeartbeatMetadata
        - `aws` AwsTypeHeartbeatMetadata
          - `enabled` boolean, required — If <code>true</code>, the AWS metadata collector is enabled on the node. Otherwise, <code>false</code>.
          - `instanceId` string, required — AWS EC2 instance ID.
          - `region` string, required — AWS region name.
          - `tags` TagsMapHeartbeatMetadata — String-keyed tag map. Each property name is a tag key and the corresponding value is the tag's string value.
          - `type` string, required — AWS EC2 instance type.
          - `zone` string, required — AWS availability zone name.
        - `azure` AzureTypeHeartbeatMetadata
          - `enabled` boolean, required — If <code>true</code>, the Azure metadata collector is enabled on the node. Otherwise, <code>false</code>.
          - `hostname` string — Azure VM hostname.
          - `instanceId` string — Azure instance ID.
          - `name` string — Azure VM name.
          - `region` string — Azure location or region.
          - `resourceGroup` string — Azure resource group name.
          - `subscriptionId` string — Azure subscription ID.
          - `tags` TagsMapHeartbeatMetadata — String-keyed tag map. Each property name is a tag key and the corresponding value is the tag's string value.
          - `type` string — Azure VM size or instance type.
          - `vmId` string — Azure VM ID.
          - `zone` string — Azure availability zone.
        - `hostOs` HostOsTypeHeartbeatMetadata
          - `addresses` string[], required — Network addresses reported by the host operating system.
          - `enabled` boolean, required — If <code>true</code>, the host operating system metadata collector is enabled on the node. Otherwise, <code>false</code>.
          - `id` string, required — Host operating system distribution name.
          - `version` string, required — Host operating system version.
        - `kube` KubeTypeHeartbeatMetadata
          - `enabled` boolean, required — If <code>true</code>, the Kubernetes metadata collector is enabled on the node. Otherwise, <code>false</code>.
          - `namespace` string, required — Kubernetes Namespace name.
          - `node` string, required — Kubernetes Node name.
          - `owner` OwnerTypeHeartbeatMetadataKube
            - `kind` string, required — Kubernetes owner resource kind.
            - `name` string, required — Kubernetes owner resource name.
          - `pod` string, required — Kubernetes Pod name.
          - `source` string, required — Kubernetes config source.
        - `os` OsTypeHeartbeatMetadata
          - `addresses` string[], required — Network addresses reported by the operating system.
          - `enabled` boolean, required — If <code>true</code>, the operating system metadata collector is enabled on the node. Otherwise, <code>false</code>.
          - `id` string, required — Operating system distribution name.
          - `version` string, required — Operating system version.
      - `node` string, required — Node.js runtime version running on the node.
      - `os` union — Operating system metadata collected from the node.
        - NodeOsInfo
          - `addresses` string[], required — Network addresses reported by the node operating system.
        - OsTypeHeartbeatMetadata
          - `addresses` string[], required — Network addresses reported by the operating system.
          - `enabled` boolean, required — If <code>true</code>, the operating system metadata collector is enabled on the node. Otherwise, <code>false</code>.
          - `id` string, required — Operating system distribution name.
          - `version` string, required — Operating system version.
      - `outpost` OutpostNodeInfo — Node information for the Outpost through which a Worker connects to the Leader.
        - `groupname` string — Name of the Outpost Group that contains the Outpost Node.
        - `guid` string, required — Unique identifier for the Outpost Node.
        - `host` string, required — Hostname or IP address for the Outpost Node.
      - `platform` string, required — Operating system platform.
      - `release` string, required — Operating system kernel release.
      - `totalDiskSpace` integer — Total disk space on the node, in bytes.
      - `totalmem` integer, required — Total memory on the node, in bytes.
    - `lastMetrics` object — Latest total, input, and destination metrics cached for UI display.
    - `lastMsgTime` integer, required — Timestamp (in Unix time) when the Leader last received a message from the node.
    - `metadata` HeartbeatMetadata
      - `aws` AwsTypeHeartbeatMetadata
        - `enabled` boolean, required — If <code>true</code>, the AWS metadata collector is enabled on the node. Otherwise, <code>false</code>.
        - `instanceId` string, required — AWS EC2 instance ID.
        - `region` string, required — AWS region name.
        - `tags` TagsMapHeartbeatMetadata — String-keyed tag map. Each property name is a tag key and the corresponding value is the tag's string value.
        - `type` string, required — AWS EC2 instance type.
        - `zone` string, required — AWS availability zone name.
      - `azure` AzureTypeHeartbeatMetadata
        - `enabled` boolean, required — If <code>true</code>, the Azure metadata collector is enabled on the node. Otherwise, <code>false</code>.
        - `hostname` string — Azure VM hostname.
        - `instanceId` string — Azure instance ID.
        - `name` string — Azure VM name.
        - `region` string — Azure location or region.
        - `resourceGroup` string — Azure resource group name.
        - `subscriptionId` string — Azure subscription ID.
        - `tags` TagsMapHeartbeatMetadata — String-keyed tag map. Each property name is a tag key and the corresponding value is the tag's string value.
        - `type` string — Azure VM size or instance type.
        - `vmId` string — Azure VM ID.
        - `zone` string — Azure availability zone.
      - `hostOs` HostOsTypeHeartbeatMetadata
        - `addresses` string[], required — Network addresses reported by the host operating system.
        - `enabled` boolean, required — If <code>true</code>, the host operating system metadata collector is enabled on the node. Otherwise, <code>false</code>.
        - `id` string, required — Host operating system distribution name.
        - `version` string, required — Host operating system version.
      - `kube` KubeTypeHeartbeatMetadata
        - `enabled` boolean, required — If <code>true</code>, the Kubernetes metadata collector is enabled on the node. Otherwise, <code>false</code>.
        - `namespace` string, required — Kubernetes Namespace name.
        - `node` string, required — Kubernetes Node name.
        - `owner` OwnerTypeHeartbeatMetadataKube
          - `kind` string, required — Kubernetes owner resource kind.
          - `name` string, required — Kubernetes owner resource name.
        - `pod` string, required — Kubernetes Pod name.
        - `source` string, required — Kubernetes config source.
      - `os` OsTypeHeartbeatMetadata
        - `addresses` string[], required — Network addresses reported by the operating system.
        - `enabled` boolean, required — If <code>true</code>, the operating system metadata collector is enabled on the node. Otherwise, <code>false</code>.
        - `id` string, required — Operating system distribution name.
        - `version` string, required — Operating system version.
    - `nodeUpgradeStatus` NodeUpgradeStatus
      - `active` 0 | 1 | 2
      - `failed` 0 | 1
      - `skipped` 0 | 1 | 2 | 3
      - `state` 0 | 1 | 2 | 3, required
      - `timestamp` integer, required — Timestamp (in Unix time) when the node entered the upgrade state, in milliseconds.
    - `offlineDurationMs` integer — Maximum configured ephemeral offline duration, in milliseconds (base + jitter cap).
    - `provisioningTokenId` string — The <code>id</code> of the provisioning token used to authenticate the node, if used.
    - `status` string — Health status reported for the node.
    - `type` 'info' | 'req' | 'resp' — RPC message type reported by the node.
    - `workerProcesses` integer, required — Number of Worker Processes running on the node.
    - `workers` MasterWorkerProcesses
      - `count` integer, required — Number of Worker Processes represented by the node entry.

## Other responses

- `401` — Authentication failed (missing or invalid credentials or Bearer token).
- `403` — Not authorized or licensed to perform this action.
- `500` — Unexpected server error.

---

[API](https://skmtc.dev/criblio/apis/cribl-api-reference.md) · [All operations](https://skmtc.dev/criblio/apis/cribl-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/criblio/cribl-api-reference/revisions/56cb25079271/schema)