KKonsol Developers
API referenceDevice parameters

Set a device's application parameter overrides

PUT
/integration/v1/devices/{id}/applications/{application_id}/parameters

Saves this device's overrides for the application.

Konsol checks them against the application's parameter schema, then delivers the resolved values to the device.

A write whose last_modified_at is not newer than the last applied one returns stale and changes nothing.

Authorization

integrationKey
headerAuthorizationBearer <token>

Your integration key, sent as Authorization: Bearer nik_<prefix>_<secret>. Konsol issues it.

Path Parameters

id*string
Formatuuid
application_id*string
Formatuuid

Request Body

application/json
  1. body

This device's overrides for the application, checked against the schema the application has published. They replace the device's previous overrides whole.

last_modified_at*string

When these values last changed in your system, on your clock. A write not newer than the last applied one is stale and changes nothing, so writes delivered out of order cannot undo a newer one.

Formatdate-time
values*

A nested values document that follows one schema revision. A key with "Can read parameter secrets" reads secret fields in the clear, so do not log or display them unmasked, unless Konsol has turned secret reads off for your organisation: that setting caps every key, takes effect at once, and needs no change to the key. Any other read returns each secret field as <secret: unchanged>, and writing that value back keeps the stored secret.

Response Body

published when the values were saved, stale when a write with an equal or newer last_modified_at was already saved

application/json
  1. response

What the write decided. stale is a success: nothing is wrong and nothing changed, so do not retry it.

outcome*string
Value in"published""stale"
revision?|

The override revision this write created, or null on stale.

Range1 <= value
applied_last_modified_at?|

The last_modified_at now standing for this device: the one just written, or the newer one that made this write stale.

Formatdate-time
Example Request
curl -X PUT 'https://api.konsol.my/integration/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/applications/497f6eca-6276-4993-bfeb-53cbbbba6f08/parameters' \  -H 'Content-Type: application/json' \  -d '{  "last_modified_at": "2019-08-24T14:15:22Z",  "values": {}}'
Example Response
{  "outcome": "published",  "revision": 1,  "applied_last_modified_at": "2019-08-24T14:15:22Z"}