API Reference

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
string
enum
required
Allowed:
string
enum
required
Defaults to discharge

discharge, charge, or idle

Allowed:
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.

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.

date-time
required

Interval start in ISO-8601 format

date-time
required

Interval end in ISO-8601 format

targets
array of objects
required
length ≥ 1
targets*
vendorParameters
array of objects
vendorParameters
tags
object

A set of client-defined key-value pairs that can be attached to an object. Tags can be used for filtering and organization.

Tags should not be used to store sensitive information (e.g., personally identifiable information or authentication data).

A maximum of 10 tags can be attached to an object

Keys:

  • case sensitive
  • can only contain URL unreserved characters (letters, digits, hyphens, periods, underscores, and tildes)
  • at most 30 characters long

Values:

  • case sensitive
  • can contain any UTF-8 character (but must be escaped in query parameters)
  • at most 100 characters long
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 8 months ago

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

Updated 8 months ago