PUT /api/v202608/esaalert/{esaAlertId}/channel/{esaChannelId}

Enables or disables a single ESA channel's association with a threshold alert

SetChannelAlertEnabledV202608 Permissions: Meters (Edit)
Use this endpoint to set whether one channel’s association with this alert should be evaluated, without detaching the channel or touching the alert’s other channel associations. Setting it writes configuration state: enforcement during evaluation arrives with ECAP-34685, and until that lands a disabled association still fires. Once enforced, a disabled association is skipped, and because its per-channel evaluation checkpoint only advances when the association is evaluated, re-enabling resumes from the next batch rather than replaying the disabled window - readings that arrived meanwhile are not evaluated. (That holds for the way production callers invoke the job, always supplying an explicit date range; invoked without one, evaluation would resume from the frozen checkpoint.) To detach a channel entirely instead, use DELETE /esaalert/{esaAlertId}/channel/{esaChannelId}. Unlike that endpoint (and unlike PUT /esaalert/{esaAlertId}), this one carries no alert-type restriction: the flag is per-association and settable for every alert type, Sentinel included.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type, including the request body.

Path Parameters

Name Description Type Required
esaAlertId Unique numeric identifier of the alert, supplied via the request path integer (int32) Required
esaChannelId Unique numeric identifier of the ESA channel whose association is being toggled, supplied via the request path integer (int32) Required

Request Body

EsaAlertSetChannelEnabled
Property Description Type
enabled Whether this channel’s association with the alert should be evaluated. True enables it; false disables it without detaching the channel. Required boolean
Example Request Body application/json
{  "enabled": false
}

Responses

204 No Content The request succeeded. No content is returned in the response body.
400 Bad Request The request was malformed or contains invalid parameters. Check the request body and query parameters.
404 Not Found The requested resource was not found. Verify the ID or path is correct.