HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Circuit / Set Session Boost

Sets the per-session DLM boost flag for an active session.

When enabled, the boosted EVSE receives the unused headroom between
the active circuit constraint (schedule limit and/or flexibility
request) and the circuit's maximum capacity, capped at the EVSE's
maximum supported current. The change applies on the next DLM
algorithm tick.

The flag persists for the remainder of the session. The boost ends
when either the session ends (no explicit call required) or the
client sends this action again with enabled: false.

Sending the same value the session already carries is accepted as
an idempotent no-op (returns 202 with no second effect).

The action is rejected with HTTP 422 if the session is not in the
active state.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
integer
required
Body Params

Request body for the set-session-boost circuit action.

boolean
required

Whether the DLM boost is active for this session. The action is
rejected with HTTP 422 if the session is not active; sending the
same value the session already carries is accepted as an
idempotent no-op.

Responses
202

Action accepted

Language
Credentials
Bearer
API Token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json