For the complete documentation index, see llms.txt. This page is also available as Markdown.

/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.

put
Authorizations
x-api-keystringRequired
Path parameters
labelpartnerstringRequired

The label partner short name

Example: default
Body

Contains 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.

enabledbooleanRequired

Indicates whether capacity peak alerts are active.

threshold_valueinteger · min: 1Optional

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.

Responses
200

Successful operation

application/json
messagestringRequired

The success message returned.

put/labelpartners/{labelpartner}/streamer/capacity-peaks/configuration
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?