Create a Control Event

post

https://api.derapi.com/control-events

Create Control Event with the specified interval and list of targets.

A Control Event can target a list of Site IDs, Derapi Program ID, or
a vendor-specific Program ID. Vendor-specific Program ID targeting only
applies to EnphaseVPP.

Event parameters can optionally include the vendorParameters object
for vendor-specific event settings.

Control Events cannot be edited after creation. To change an upcoming Control
Event you should cancel and reschedule before the event start time.

Body Params

type

string

enum

required

Allowed:

command

string

enum

required

Defaults to discharge

discharge, charge, or idle

Allowed:

powerKw

number

charge or discharge rate, in kilowatts.

Either this setting (powerKw) or powerPercent must be set if the command is charge or discharge; for idle, it must be absent.

This value will apply individually to every Site included in the control event.
For example: if 5 Sites are targeted, with a powerKw value of 5.0 kW, each will be
sent a control command for charge or discharge of 5.0 kW.

powerPercent

number

0 to 100

charge or discharge rate, as a percentage of the maximum charge or discharge rate supported for each targeted Site.

Either this setting (powerPercent) or powerKw must be set for charge or discharge; for idle, it must be absent.

start

date-time

required

Interval start in ISO-8601 format

end

date-time

required

Interval end in ISO-8601 format

targets

array of objects

required

length ≥ 1

targets*

vendorParameters

array of objects

vendorParameters

202Accepted

409A conflicting control event already exists

422A validation error