Skip to navigation

Register a charger point

Registers a charger on the OCPP gateway for the organization in the Bearer JWT. An optional basic_auth_password sets the charger’s HTTP Basic credentials; it is never returned (see has_basic_auth). 409 if the charge_point_id is already registered.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
charge_point_idstringRequired1-255 characters
Id the charger uses in its WebSocket path.
labelstring or nullOptional
vendorstring or nullOptional
modelstring or nullOptional
serial_numberstring or nullOptional
firmware_versionstring or nullOptional
ocpp_versionenum or nullOptional
Allowed values:
enabledbooleanOptionalDefaults to true
security_profileintegerOptional0-3Defaults to 0
metadatamap from strings to anyOptional
basic_auth_passwordstring or nullOptional16-40 characters

Write-only; responses expose only has_basic_auth.

Response

Successful Response
idstringformat: "uuid"
charge_point_idstring
created_atdatetime
updated_atdatetime
labelstring or nullOptional
vendorstring or nullOptional
modelstring or nullOptional
serial_numberstring or nullOptional
firmware_versionstring or nullOptional
ocpp_versionenum or nullOptional
Allowed values:
enabledbooleanOptionalDefaults to true
security_profileintegerOptionalDefaults to 0
metadatamap from strings to anyOptional
has_basic_authbooleanOptionalDefaults to false
last_seen_atdatetime or nullOptional
revisionintegerOptionalDefaults to 1
Bumped on every update.

Errors

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