KKonsol Developers
API referenceDevice parameters

Get a device's application parameter overrides

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

Returns this device's overrides for the application.

The values come back exactly as last written, with the last_modified_at they were written with. For the values the device runs, with the schema defaults and the application's values filled in, call GET /integration/v1/devices/{id}/applications/{application_id}/parameters/resolved.

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

Response Body

The device's overrides

application/json
  1. response

The device's overrides for one application, as last published.

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.

revision*integer

The published revision of these values.

Range1 <= value
published_at*string
Formatdate-time
last_modified_at?|

The last_modified_at of the last write through this API that applied, or null when there is none.

Formatdate-time
Example Request
curl -X GET 'https://api.konsol.my/integration/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/applications/497f6eca-6276-4993-bfeb-53cbbbba6f08/parameters'
Example Response
{  "values": {},  "revision": 1,  "published_at": "2019-08-24T14:15:22Z",  "last_modified_at": "2019-08-24T14:15:22Z"}