Skip to navigation
ProxyCommands

Send an OCPI command to a charger

Translates an OCPI command (START_SESSION, STOP_SESSION, …) into OCPP through the gateway. Poll GET /proxy/ocpi/commands/{tracking_id} with the returned tracking_id for the OCPI CommandResult.

Authentication

AuthorizationBearer

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

Path parameters

commandenumRequired
OCPI command type.

Headers

X-Request-Idstring or nullOptionalformat: "^[\x21-\x7e]+$"<=64 characters
X-Correlation-Idstring or nullOptionalformat: "^[\x21-\x7e]+$"<=128 characters

Request

This endpoint expects an object.
payloadmap from strings to anyRequired
OCPI command body exactly as the eMSP would send it.
ocpi_versionenumOptionalDefaults to v221
Allowed values:
country_codestring or nullOptionalformat: "^[A-Z]{2}$"

CPO country code; with party_id it picks one CPO party.

party_idstring or nullOptionalformat: "^[A-Z0-9]{3}$"

CPO party id (3 characters).

Response

Successful Response
resultenum
Allowed values:
timeoutinteger
messagelist of objects or nullOptional
tracking_idstring 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