/labelpartners/{labelpartner}/streamer/capacity-peaks/configuration
Sets the capacity peak threshold in the cp_mgmt shadow for all devices registered to a specific label partner. The label partner setting overrides any previously applied per-device configuration. Edge events must be enabled for the label partner before this endpoint can be used. threshold_value is always required when enabled is true.
The label partner short name
defaultContains the capacity peak threshold configuration. enabled is required. threshold_value is required when enabling for the first time; omit it to reuse the previously configured value.
Indicates whether capacity peak alerts are active.
The capacity peak threshold in Watts. Required when enabling for the first time. If omitted on subsequent enabled=true requests, the previously set value is reused. Ignored when enabled=false.
Successful operation
The success message returned.
Invalid request:
- Request body is required but was not provided.
- Schema validation failed due to error: Missing required key: 'enabled'.
- Schema validation failed due to error: Invalid type for key: '{key}'.
- Schema validation failed due to error: Value for key 'threshold_value' must be at least 1.
- Schema validation failed due to error: Missing required key: 'threshold_value'. It must be specified when enabling capacity peaks for the first time.
- Edge events are not enabled for label partner '{labelpartner}'.
Not found:
- The thing group '{labelpartner}' was not found in the registry.
- The thing group '{labelpartner}' does not have any IoT Things associated with it.
Internal server error
PUT /v2/labelpartners/{labelpartner}/streamer/capacity-peaks/configuration HTTP/1.1
Host: device-management.n2g-dev.net
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"enabled": true,
"threshold_value": 1
}{
"message": "text"
}Last updated
Was this helpful?

