Schemas

Information related to the created device.

Device certificate.

Information related to the created network.

Endpoint Key to keep secret. This cannot be retrieved later.

Device ID, also used as MQTT Client ID or username.

Device name.

Device description.

Device status.

Hub ID.

Last connection/activity date of a device. (RFC 3339 format)

Defines whether the device is connected to the Hub.

Defines whether to allow the device to connect to the Hub without TLS mutual authentication.

Defines whether to allow multiple physical devices to connect to the Hub with this device's credentials.

Filter-sets to restrict the topics the device can publish/subscribe to.

Defines whether the device was assigned a custom certificate. Assigning a custom certificate allows a device to authenticate using that specific certificate without checking the Hub's CA certificate.

Date at which the device was added. (RFC 3339 format)

Date at which the device was last modified. (RFC 3339 format)

Region of the device.

Filtering rule to restrict topics the device can publish to.

Filtering rule to restrict topics the device can subscribe to.

How to use the topic list. If set to accept, all topics in the topics list will be allowed, with all other topics being denied. If set to reject, all topics in the topics list will be denied, with all other topics being allowed.

List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters.

Information related to the created device.

Device certificate.

Metrics for a device over the requested period.

Metrics for a Hub over the requested period.

Hub ID.

Hub name.

Current status of the Hub.

Hub feature set.

Defines whether the hub has been enabled.

Number of registered devices.

Number of currently connected devices.

Host to connect your devices to. 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).

Defines whether to disable Hub events.

Hub events topic prefix.

Region of the Hub.

Hub creation date. (RFC 3339 format)

Hub last modification date. (RFC 3339 format)

Project owning the resource.

Organization owning the resource.

Defines whether to enable device auto provisioning. 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 certificate 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.

Defines whether the hub is using a custom certificate authority. 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.

BETA - not implemented yet.

Total number of devices.

Page of devices.

Total number of Hubs.

A page of hubs.

Total number of Networks.

Page of networks.

Total number of routes.

Page of routes.

List of the twin document.

Name of the document.

Network ID.

Network name.

Type of network to connect with.

Endpoint to use for interacting with the network.

Hub ID to connect the Network to.

Date at which the network was created. (RFC 3339 format)

Topic prefix for the Network. This prefix will be prepended to all topics for this Network.

Region of the network.

Information related to the created device.

Device certificate.

Route ID.

Route name.

Hub ID of the route.

Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters.

Route type.

Date at which the route was created. (RFC 3339 format)

When using Amazon S3 Routes, Amazon S3-specific configuration fields.

When using Database Route, DB-specific configuration fields.

When using Rest Route, Rest-specific configuration fields.

Date at which the route was last updated. (RFC 3339 format)

Region of the route.

Database host.

Database port.

Database name.

Database username. Make sure this account can execute the provided query.

Database password.

Database engine the route will connect to. If not specified, the default database will be 'PostgreSQL'.

SQL query to be executed ($TOPIC and $PAYLOAD variables are available, see documentation).

HTTP verb used to call REST URI.

URI of the REST endpoint.

HTTP call extra headers.

Region of the Amazon S3 route's destination bucket (e.g., 'fr-par').

Destination bucket name of the Amazon S3 route.

Optional string to prefix object names with.

How the Amazon S3 route's objects will be created: one per topic or one per message.

Route ID.

Route name.

Hub ID of the route.

Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters.

Route type.

Date at which the route was created. (RFC 3339 format)

Date at which the route was last updated. (RFC 3339 format)

Region of the route.

Parent twin ID of the document.

Name of the document.

New version of the document.

New data related to the document.