Skip to main content
Settings define threshold values, control parameters, and actuator behaviors for each sector.

​
List All Settings

GET /api/v1/tenants/{tenantId}/settings
​
tenantId
integer
required
Tenant ID

​
Response

​
id
integer
Unique setting identifier
​
sectorId
integer
Associated sector ID
​
parameterId
integer
Data type parameter ID (temperature, humidity, etc.)
​
actuatorStateId
integer
Target actuator state (ON, OFF, AUTO, etc.)
​
minValue
number
Minimum threshold value
​
maxValue
number
Maximum threshold value
​
isActive
boolean
Whether this setting is currently active

​
List Sector Settings

Get all settings for a specific sector. 
GET /api/v1/tenants/{tenantId}/settings/sector/{sectorId}
​
tenantId
integer
required
Tenant ID
​
sectorId
integer
required
Sector ID

​
Example

cURL
curl -X GET "https://api.example.com/api/v1/tenants/1/settings/sector/5" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

​
Get Active Settings

Get only active settings for a sector. 
GET /api/v1/tenants/{tenantId}/settings/sector/{sectorId}/active
This endpoint filters settings where isActive = true, useful for runtime automation logic.

​
Get Setting by ID

GET /api/v1/tenants/{tenantId}/settings/{settingId}
​
tenantId
integer
required
Tenant ID
​
settingId
integer
required
Setting ID

​
Create Setting

POST /api/v1/tenants/{tenantId}/settings

​
Request Body

​
sectorId
integer
required
Sector ID where this setting applies
​
parameterId
integer
required
Data type ID (1=INTEGER, 2=BOOLEAN, 3=STRING, 4=DOUBLE, etc.)
​
actuatorStateId
integer
required
Actuator state ID (1=ON, 2=OFF, 3=AUTO, etc.)
​
minValue
number
Minimum threshold (e.g., 18.0°C)
​
maxValue
number
Maximum threshold (e.g., 28.0°C)
​
isActive
boolean
Whether to activate this setting immediately (default: true)

​
Example

cURL
curl -X POST "https://api.example.com/api/v1/tenants/1/settings" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sectorId": 5,
    "parameterId": 4,
    "actuatorStateId": 1,
    "minValue": 18.0,
    "maxValue": 28.0,
    "isActive": true
  }'

​
Update Setting

PUT /api/v1/tenants/{tenantId}/settings/{settingId}
​
tenantId
integer
required
Tenant ID
​
settingId
integer
required
Setting ID

​
Request Body

All fields are optional for updates.
​
minValue
number
Updated minimum threshold
​
maxValue
number
Updated maximum threshold
​
actuatorStateId
integer
Updated actuator state
​
isActive
boolean
Activate or deactivate the setting

​
Delete Setting

DELETE /api/v1/tenants/{tenantId}/settings/{settingId}
Deleting a setting removes the threshold configuration. Automation rules relying on this setting will no longer function.

​
Query by Parameter

Get settings for a specific parameter type across a sector. 
GET /api/v1/tenants/{tenantId}/settings/sector/{sectorId}/parameter/{parameterId}
​
tenantId
integer
required
Tenant ID
​
sectorId
integer
required
Sector ID
​
parameterId
integer
required
Parameter ID (data type)

​
Query by Actuator State

Get settings configured for a specific actuator state. 
GET /api/v1/tenants/{tenantId}/settings/sector/{sectorId}/actuator-state/{actuatorStateId}
​
tenantId
integer
required
Tenant ID
​
sectorId
integer
required
Sector ID
​
actuatorStateId
integer
required
Actuator state ID

​
Query by Parameter and Actuator State

Get settings matching both a parameter type and actuator state. 
GET /api/v1/tenants/{tenantId}/settings/sector/{sectorId}/parameter/{parameterId}/actuator-state/{actuatorStateId}
This endpoint is useful for finding the exact threshold that triggers a specific actuator action.

​
Example

cURL
# Find temperature settings that turn irrigation ON
curl -X GET "https://api.example.com/api/v1/tenants/1/settings/sector/5/parameter/4/actuator-state/1" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Build docs developers (and LLMs) love

Get started for freeTalk to us