Set a temporary limit to a grid

This provides a more simple way to set a temporary external limit to a grid compared to chargeprofiles with the cost of less flexibility. Multiple limits of different types (A or KW) can be set to a grid with an expiry time and and a safe-current. These limits can be updated or deleted using a name specified by the user

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

(Default) grid Id. Eigher this parameter OR GID must be provided. This Grid-ID corresponds to the grid in the "Grid configuration" tab.

int32

(Advanced) Grid Unique Identifier. Eigher this parameter OR GridId must be provided. It can only be fetched by calling "/grid/getGridConfig" and reading it from the config. This GID is unique for a grid and will change when the config is changed. It is usefull for breaking the API when someone changes the configuration of the grid.

string
required

Unique name for this limit. If a new limit is written with the same name it will overwrite the limit. The use of the 'gridId' as name is advised when you only have a single limit for a grid.

integer
required

Grid limit in ampere or kilowatt

string

(Optional) A or KW. Will default to A if not provided

boolean

(Optional) If false, if the grid has an energy meter the limit will apply to the energy meter. if true, the limit is does apply to the total regulated consumption(EV current). (Since Edge V1.29.2)

integer
required

The limit will expire after 'timeout' seconds. If the timeout is set to 0 the limit will remain active until the limit is explicitly deleted. If the 'limitAfterTimeout' parameter is set the limit will not be deleted and will change into 'limitAfterTimeout' when the timeout has been reached.

integer

(Optional) After the timeout has passed, the configured 'limit' will change to this this 'limitAfterTimeout' parameter untill the softlimit is explicitly removed or overwritten. It is usefull to set a safe-current for when the communicaiton is interrupted When this parameter is not given, or a negative value is provided (-1), the temporary softlimit is automatically removed when 'timeout' seconds have passed.

Responses
200

successful operation

400

Bad request

401

Not authorized

403

No access with API role

405

Method not allowed

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!