---
title: "Get a Hub by id"
method: GET
path: "/v1/data-acquisition/hubs/{id}"
tags: ["Hubs"]
---

# Get a Hub by id

`GET /v1/data-acquisition/hubs/{id}`

**:warning: This is a new API which is still subject to change.**

Use this endpoint to get a Hub's details by id.

## Path parameters

- `id` string, required

## Query parameters

- `include` string[]

## Response `200`

Successful response with a Hub's details

- HubDetailsDto
  - `id` string, required
  - `name` string, required
  - `orgSlug` string, required
  - `description` string, required
  - `httpProxyHost` string, required
  - `httpProxyPort` number, required
  - `httpProxyUsername` string, required
  - `httpsProxyHost` string, required
  - `httpsProxyPort` number, required
  - `httpsProxyUsername` string, required
  - `noProxy` string, required
  - `l7ProxyForwardPort` number, required
  - `l7ProxyReverseHttpPort` number, required
  - `l7ProxyReverseHttpsPort` number, required
  - `l7ProxySocatPort` number, required
  - `l7ProxyReverseMqttPort` number, required
  - `l7ProxySocatMqttPort` number, required
  - `l7ProxyLocalnets` string, required
  - `l7ProxyDnsNameservers` string, required
  - `l7ProxyWhitelist` string, required
  - `l7ProxyMaximumMemoryMb` number, required
  - `enabled` boolean, required
  - `status` HubStatusDto, required
    - `health` object, required — The health status of the Hub.
      - `breakdown` object[]
        - `name` 'Availability' | 'CPU' | 'Disk' | 'Memory' | 'ProxyMemory' | 'ProxyMemoryMax' | 'ProxyAvailability'
        - `status` 'HEALTHY' | 'WARNING' | 'CRITICAL'
      - `status` 'HEALTHY' | 'WARNING' | 'CRITICAL' — The overall health status of the Hub. Rolls up to the most severe status in the breakdown.
    - `network` 'Online' | 'Offline' | 'Never Seen', required — The network status of the Hub.
    - `lastSeen` string, date-time, required — The last time the Hub was seen by the platform.
    - `metrics` object[], required
      - `cpuUsedSystem` object
        - `value` number
        - `unit` 'Percent'
      - `cpuUsedUser` object
        - `value` number
        - `unit` 'Percent'
      - `diskFree` object
        - `value` number
        - `unit` 'Bytes'
      - `diskUsed` object
        - `value` number
        - `unit` 'Percent'
      - `memoryUsed` object
        - `value` number
        - `unit` 'Bytes'
      - `memoryFree` object
        - `value` number
        - `unit` 'Bytes'
      - `memoryBuffered` object
        - `value` number
        - `unit` 'Bytes'
      - `memoryCached` object
        - `value` number
        - `unit` 'Bytes'
      - `memoryAvailable` object
        - `value` number
        - `unit` 'Bytes'
      - `memoryTotal` object
        - `value` number
        - `unit` 'Bytes'
      - `memoryUsedPercentOfReservation` object
        - `value` number
        - `unit` 'Percent'
      - `memoryMax` object
        - `value` number
        - `unit` 'Bytes'
    - `proxies` object, required — The status of the Hub's built-in Agent proxies.
      - `l7` object
        - `startedAt` string, date-time
        - `status` 'RUNNING' | 'STOPPED'
      - `l7ReverseNginx` object
        - `startedAt` string, date-time
        - `status` 'RUNNING' | 'STOPPED'
      - `l7ReverseSocat` object
        - `startedAt` string, date-time
        - `status` 'RUNNING' | 'STOPPED'
      - `metrics` object[]
        - `cpuUsed` object
          - `value` number
          - `unit` 'Percent'
        - `memoryUsed` object
          - `value` number
          - `unit` 'Bytes'
        - `memoryUsedPercentOfMax` object
          - `value` number
          - `unit` 'Percent'
        - `memoryUsedPercentOfReservation` object
          - `value` number
          - `unit` 'Percent'
        - `memoryMax` object
          - `value` number
          - `unit` 'Bytes'
  - `host` HubHostDto, required
    - `ipAddress` string, required — The Hub's IP address.
    - `hostName` string, required — The Hub's host name.
    - `platformName` string, required — The Hub's operating system name.
    - `platformVersion` string, required — The Hub's operating system version.
  - `updatedAt` string, date-time, required
  - `createdAt` string, date-time, required
  - `activationExpiresAt` string, date-time, required
  - `ssmInstanceId` string, required
  - `ecsContainerInstanceArn` string, required
  - `connectors` HubConnectorDto[], required
    - `id` string, required
    - `name` string, required
    - `artifact` ArtifactDto, required
      - `namespace` string, required
      - `slug` string, required
      - `version` string, required
    - `hostType` 'cloud' | 'hub', required — The type of host the Connector is running on.
    - `health` string, required
    - `healthErrorCode` string, required
    - `operatingStatus` string, required
    - `networkStatus` string, required
    - `lastSeenAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `createdAt` string, date-time, required

---

[API](https://skmtc.net/tetrascience/apis/tetra-data-lake.md) · [All operations](https://skmtc.net/tetrascience/apis/tetra-data-lake/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tetrascience/tetra-data-lake/revisions/0205e2bace53/schema)