Interface Hub

interface Hub {
    connectedDeviceCount: number;
    createdAt?: Date;
    deviceCount: number;
    disableEvents: boolean;
    enableDeviceAutoProvisioning: boolean;
    enabled: boolean;
    endpoint: string;
    eventsTopicPrefix: string;
    hasCustomCa: boolean;
    id: string;
    name: string;
    organizationId: string;
    productPlan: HubProductPlan;
    projectId: string;
    region: Region;
    status: HubStatus;
    twinsGraphiteConfig?: HubTwinsGraphiteConfig;
    updatedAt?: Date;
}

Properties

connectedDeviceCount createdAt? deviceCount disableEvents enableDeviceAutoProvisioning enabled endpoint eventsTopicPrefix hasCustomCa id name organizationId productPlan projectId region status twinsGraphiteConfig? updatedAt?

Properties

connectedDeviceCount

connectedDeviceCount: number

Number of currently connected devices.

OptionalcreatedAt

createdAt?: Date

Hub creation date.

deviceCount

deviceCount: number

Number of registered devices.

disableEvents

disableEvents: boolean

Defines whether to disable Hub events.

enableDeviceAutoProvisioning

enableDeviceAutoProvisioning: boolean

When an unknown device connects to your hub using a valid certificate chain, it will be automatically provisioned inside your Hub. The Hub uses the common name of the device certifcate to find out if a device with the same name already exists. This setting can only be enabled on a hub with a custom certificate authority.

enabled

enabled: boolean

Defines whether the hub has been enabled.

endpoint

endpoint: string

Devices should be connected to this host. Port may be 1883 (MQTT), 8883 (MQTT over TLS), 80 (MQTT over Websocket) or 443 (MQTT over Websocket over TLS).

eventsTopicPrefix

eventsTopicPrefix: string

Hub events topic prefix.

hasCustomCa

hasCustomCa: boolean

Flag is automatically set to false after Hub creation, as Hub certificates are managed by Scaleway. Once a custom certificate authority is set, the flag will be set to true.

id

id: string

Hub ID.

name

name: string

Hub name.

organizationId

organizationId: string

Organization owning the resource.

productPlan

productPlan: HubProductPlan

Hub feature set.

projectId

projectId: string

Project owning the resource.

region

region: Region

Region of the Hub.

status

status: HubStatus

Current status of the Hub.

OptionaltwinsGraphiteConfig

twinsGraphiteConfig?: HubTwinsGraphiteConfig

BETA - not implemented yet.

One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be set.

OptionalupdatedAt

updatedAt?: Date

Hub last modification date.

Settings

On This Page

Properties