Skip to main content

Parameters

The Parameters API provides access to feature parameters stored in the Luniris OS database. This API enables reading, writing, and real-time monitoring of parameter changes made through the settings interface.

Prerequisites​

1. Parameter Configuration​

Parameters Configuration

Parameters must be defined in your settings.manifest.json file before they can be accessed via this API.

Follow the Settings Manifest Guide to configure your parameters.

2. Authentication​

Authentication Required

Access to parameters requires a valid authentication token:

  • Token is available via the TOKEN environment variable
  • Must be included in gRPC metadata headers

Protocol Buffer Definition​

syntax = "proto3";
import "google/protobuf/empty.proto";

service ParametersService {
  // Retrieves the current value of a parameter
  rpc GetParameterValue (Parameter) returns (Parameter);

  // Updates a parameter value
  rpc SetParameterValue (Parameter) returns (Parameter);

  // Streams real-time parameter updates
  rpc StreamParameterUpdates (google.protobuf.Empty) returns (stream Parameter);
}

// Parameter key-value pair
message Parameter {
  string key = 1;    // Parameter identifier (from settings.manifest.json)
  string value = 2;  // Current parameter value (always string)
}