Skip to navigation

Set or clear a charger's input limit

Sends an OCPP charging profile to the charger. The result is PENDING until the charger answers: read it back with GET /energy-management/control-requests/{request_id}, or subscribe a webhook to energy.control_response.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Idempotency-Keystring or nullOptional1-128 characters
Optional key you choose. Repeating a request with the same key returns the first request and sends nothing to the charger.

Request

This endpoint expects an object.
charge_point_idstringRequired1-36 characters
actionenumRequired
Set or clear a charger input limit.
Allowed values:
connector_idinteger or nullOptional>=0Defaults to 0
limitdouble or nullOptional>=0
unitenum or nullOptional
Watts or amps.
Allowed values:
valid_todatetime or nullOptional

Response

The request, PENDING until the charger answers.
request_idstring
charge_point_idstring
connector_idinteger
actionenum or any
resultenum or any
created_atdatetime
limitdouble or nullOptional
unitenum or any or nullOptional
valid_todatetime or nullOptional
detailstring or nullOptional
tracking_idstring or nullOptional
completed_atdatetime or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error