/configurations

post

https://api.rigado.com/v1/configurations

Sends configuration data to a Gateway

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

serial

string

required

The Gateway's unit serial number

dryRun

boolean

If true, just performs simple validation of the form of provided settings

Body Params

An object describing the configuration for a Gateway. A configuration for network settings cannot include configurations for the connection default-ethernet-dhcp.

errors

array of objects

Errors, if any, resulting from attempts to apply the configurations on the gateway. Reported for the most recent configuration request made of a given type for a gateway.

errors

meta

string

Meta detail relevant to the most recent desired configuration request Only applicable to NETWORK type configurations Valid values are "MANUALLY_RESET", which means a manual reset triggered on the hardware reset all previous network configs, and "APPLY_AFTER_RESET", which indicates that a new complete NETWORK configuration is being requested after a manual reset. This allows for the resubmission of the last requested config without change

settings

string

The actual configuration settings for the gateway. Communicated over the wire as standard JSON.

Nil value interpreted as requesting the removal of all configuration settings for this configuration type

state

string

State represents the the current state of application of a given config

type

string

updated

string

The time this configuration request was last modified. Reported for the most recent configuration request made of a given type for a gateway. Reported in UTC in RFC3339 format.

version

int64

Desired Config Version Number of the configuration

Responses

200

Configuration successfully handled for Gateway

202

Configuration sent to non-stateful Gateway. Gateway appears offline, so it might not have worked

400

StateError reading request body, or config data invalid, configuration feature not supported on Gateway or for Org, or Gateway is in a Site

401

Unauthorized

404

Gateway or Apps not found

500

StateError managing Config for Gateway

Language

Credentials

Loading…

Response

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