JouloDocs

Add a charger

Registers a new charger on your account. Currently supports OCPP chargers — other connection types must be added through the Joulo dashboard.

For OCPP chargers, the response includes the WebSocket endpoint and password your charge point should use to connect to Joulo's CPMS.

POST
/chargers
AuthorizationBearer <token>

API token from the Joulo dashboard, or an OAuth2 access token.

In: header

nicknamestring

A user-defined name for the charger.

Length1 <= length <= 100
connection_typestring

How the charger connects to Joulo. Currently only ocpp is supported via the API.

Value in"ocpp"
ocpp_identity?string

The charge point identity string configured on your OCPP charger. Must be unique across your account. If omitted, Joulo generates one automatically.

Match^[A-Za-z0-9_\-]+$
Length1 <= length <= 64

Response Body

curl -X POST "https://api.joulo.nl/functions/v1/api/chargers" \
  -H "Content-Type: application/json" \
  -d '{
    "nickname": "Oprit",
    "connection_type": "ocpp",
    "ocpp_identity": "CHARGER-001"
  }'
{
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "nickname": "Oprit",
  "connection_type": "ocpp",
  "status": "offline",
  "mid_certified": false,
  "is_charging": false,
  "ocpp": {
    "identity": "CHARGER-001",
    "endpoint": "wss://ocpp.joulo.nl/CHARGER-001",
    "password": "a8f3b2e1c4d5"
  }
}
{
  "error": "connection_type is required and must be \"ocpp\""
}
{
  "error": "Missing or invalid API token"
}
{
  "error": "Insufficient scope",
  "required_scope": "chargers:read"
}
{
  "error": "A charger with ocpp_identity \"CHARGER-001\" already exists"
}