Skip to navigation
ProxyBackends

Register a CSMS backend

Admin only (role=admin). Registers a CSMS backend (WebSocket URL and write-only auth credentials) the OCPP gateway can forward charger traffic to; routing rules then point chargers at it. 409 if it already exists.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequired1-255 characters
urlstringRequired1-255 characters
CSMS WebSocket URL.
enabledbooleanOptionalDefaults to true
priorityintegerOptionalDefaults to 100
authmap from strings to anyOptional

Write-only CSMS credentials; never returned.

Response

Successful Response
idstringformat: "uuid"
namestring
urlstring
created_atdatetime
updated_atdatetime
enabledbooleanOptionalDefaults to true
priorityintegerOptionalDefaults to 100
revisionintegerOptionalDefaults to 1
Bumped on every update.

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error