/gateways/{serial}/config

put

https://api.rigado.com/v1/gateways/{serial}/config

Sends configuration data to a Gateway

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

serial

string

required

The Gateway's unit serial number

Body Params

An object describing the configuration for a Gateway

Describes configuration for a gateway. Configuration of App settings, Networking, and Time is supported.

Each app has a set of key/value pairs that is sent to the configuration hook of the app on the Gateway. Note that these are not ordered lists, and could be processed in any order. If order is required, send multiple configuration requests.

Network configuration is provided in the pattern of Ubuntu Network Manager, but nested values are nested in JSON objects rather than with dot notation.

apps

object

Maps application names to their configuration, which is represented by a AppConfig object. See AppConfig for more information.

network

object

Maps a user provided unique ID for a connection to its configuration. Based on configuration of the Linux NetworkManager. Used for adding or modifying connections. The structure of the map is string keys mapped to NetworkConnection value objects. Each entry represents a uniquely named connection.

time

object

Describes time configuration for a gateway. Enables setting NTP servers, as well as specifying the timezone of the gateway.

Responses

200

On successful processing of GatewayConfig

202

GatewayConfig sent, but Gateway appears offline, so it might not have worked

400

StateError reading request body, Gateway doesn't exist, config data invalid, or gateway is assigned to a site

401

Unauthorized

404

Gateway or Apps not found

500

StateError sending Config to Gateway

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here!