Get all Hubs

get https://api.tetrascience.com/v1/data-acquisition/hubs

⚠️ This is a new API which is still subject to change.

Use this endpoint to get a list of Hubs.

Response

Response body

object

hubs

array of objects

required

hubs*

object

string

required

The Hub's id.

name

string

required

The Hub's name.

orgSlug

string

required

The organization slug that the Hub belongs to.

description

string

The Hub's description.

httpProxyHost

string

The Hub's http parent proxy host, if set.

httpProxyPort

number

The Hub's http parent proxy port, if set.

httpProxyUsername

string

A legacy field from when Hub's parent proxy was configured in the cloud; no longer populated.

httpsProxyHost

string

The Hub's https parent proxy host, if set.

httpsProxyPort

number

The Hub's https parent proxy port, if set.

httpsProxyUsername

string

A legacy field from when Hub's parent proxy was configured in the cloud; no longer populated.

noProxy

string

The Hub's no proxy list, if set.

l7ProxyForwardPort

number

required

The Hub's L7 proxy forward port, used by Agents automatically when using this Hub.

l7ProxyReverseHttpPort

number

required

The Hub's L7 proxy reverse http port, configured explicitly on Agents.

l7ProxyReverseHttpsPort

number

required

The Hub's L7 proxy reverse https port, configured explicitly on Agents.

l7ProxySocatPort

number

required

The Hub's L7 proxy socat port. Not used externally, but configurable to avoid port conflicts.

l7ProxyReverseMqttPort

number

The Hub's L7 proxy reverse mqtt port, if set, configured explicitly on IoT Agents.

l7ProxySocatMqttPort

number

The Hub's L7 proxy socat mqtt port. Not used externally, but configurable to avoid port conflicts.

l7ProxyLocalnets

string

required

The Hub's L7 proxy localnets, if set.

l7ProxyDnsNameservers

string

The Hub's L7 proxy dns nameservers, if set explicitly. Otherwise, defaults to the host VM's.

l7ProxyWhitelist

string

The Hub's L7 proxy whitelist, if set. If not set, all endpoints are allowed.

l7ProxyMaximumMemoryMb

number

required

The Hub's L7 proxy maximum memory in MB, if set.

enabled

boolean

required

Whether the Hub is enabled. When disabled, Hub Connectors are disabled but the SSM and ECS Agents continue to await commands.

status

object

The Hub's status. Only present on the list endpoint if include=status is passed. Not present when Hub info is returned on Connectors endpoints.

host

object

required

updatedAt

date-time

required

createdAt

date-time

required

activationExpiresAt

date-time

required

The time at which the Hub's activation will expire. 24 hours after creation.

ssmInstanceId

string

The Hub's AWS Systems Manager instance id, if the Hub has been installed.

ecsContainerInstanceArn

string

The Hub's AWS ECS container instance ARN, if the Hub has been installed.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.tetrascience.com/v1/data-acquisition/hubs \
3
     --header 'accept: application/json'


xxxxxxxxxx
142
}
1
{
2
  "hubs": [
3
    {
4
      "id": "string",
5
      "name": "string",
6
      "orgSlug": "string",
7
      "description": "string",
8
      "httpProxyHost": "string",
9
      "httpProxyPort": 0,
10
      "httpProxyUsername": "string",
11
      "httpsProxyHost": "string",
12
      "httpsProxyPort": 0,
13
      "httpsProxyUsername": "string",
14
      "noProxy": "string",
15
      "l7ProxyForwardPort": 0,
16
      "l7ProxyReverseHttpPort": 0,
17
      "l7ProxyReverseHttpsPort": 0,
18
      "l7ProxySocatPort": 0,
19
      "l7ProxyReverseMqttPort": 0,
20
      "l7ProxySocatMqttPort": 0,
21
      "l7ProxyLocalnets": "string",
22
      "l7ProxyDnsNameservers": "string",
23
      "l7ProxyWhitelist": "string",
24
      "l7ProxyMaximumMemoryMb": 0,
25
      "enabled": true,

200Successful response with a list of all Hubs