KKonsol Developers
API referenceDevice parameters

Get a device's resolved application parameters

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

Returns the values Konsol resolves for this device and application.

Konsol applies the schema defaults, then the application's values, then the device's overrides. The response also shows what the device last reported holding.

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 resolved parameters

application/json
  1. response

The values Konsol resolves for one device and application, and what the device last reported holding. For a key without "Can read parameter secrets", digest and device.digest are tokens that are equal exactly when the device holds these values, not fingerprints of them.

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.

digest*ParameterDigest

A fingerprint of a set of resolved parameter values. Equal values always give the same digest, so a device that reports this digest already holds these values.

Match^sha256:[0-9a-f]{64}$
schema_revision*integer

The published schema revision values follows.

Range1 <= value
complete*boolean

False when a required field resolves to no value.

unresolved*array<string>

The dotted paths of required fields that resolve to no value.

applied_last_modified_at*|

The last_modified_at of the override write standing for this device, or null when none has been applied.

Formatdate-time
device*

The device's last report. never_reported means Konsol has not heard from the device about these parameters yet.

Example Request
curl -X GET 'https://api.konsol.my/integration/v1/devices/497f6eca-6276-4993-bfeb-53cbbbba6f08/applications/497f6eca-6276-4993-bfeb-53cbbbba6f08/parameters/resolved'
Example Response
{  "values": {},  "digest": "sha256:3b1f2a8c9d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8",  "schema_revision": 1,  "complete": true,  "unresolved": [    "string"  ],  "applied_last_modified_at": "2019-08-24T14:15:22Z",  "device": {    "status": "in_sync",    "digest": "sha256:3b1f2a8c9d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5f60718293a4b5c6d7e8",    "applied_at": "2019-08-24T14:15:22Z",    "observed_at": "2019-08-24T14:15:22Z"  }}