Creates a controller

curl --request POST \
  --url https://api.chargecloud.dev/api/v1/assets/controllers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_uuid": "<string>",
  "logging": true,
  "fairmode": false,
  "software": "ABB",
  "name": "<string>",
  "charge_point_model": "<string>",
  "ssl": false,
  "ip_address": "<string>",
  "dns_name": "<string>",
  "ip_port": 123,
  "proxy_port": 123,
  "manufacturer": "<string>",
  "mobile_number": "<string>",
  "icc_id": "<string>",
  "imsi": "<string>",
  "imei": "<string>",
  "sim_card_name": "<string>",
  "radius_pwd": "<string>",
  "pin": "<string>",
  "puk": "<string>",
  "alternative_heartbeat_interval": 3630,
  "alternative_meter_values_interval": 3630,
  "alternative_ftp_host": "<string>",
  "serial_number": "<string>",
  "article_number": "<string>",
  "u_ids": [
    {
      "u_id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.chargecloud.dev/api/v1/assets/controllers"

payload = {
    "location_uuid": "<string>",
    "logging": True,
    "fairmode": False,
    "software": "ABB",
    "name": "<string>",
    "charge_point_model": "<string>",
    "ssl": False,
    "ip_address": "<string>",
    "dns_name": "<string>",
    "ip_port": 123,
    "proxy_port": 123,
    "manufacturer": "<string>",
    "mobile_number": "<string>",
    "icc_id": "<string>",
    "imsi": "<string>",
    "imei": "<string>",
    "sim_card_name": "<string>",
    "radius_pwd": "<string>",
    "pin": "<string>",
    "puk": "<string>",
    "alternative_heartbeat_interval": 3630,
    "alternative_meter_values_interval": 3630,
    "alternative_ftp_host": "<string>",
    "serial_number": "<string>",
    "article_number": "<string>",
    "u_ids": [{ "u_id": "<string>" }]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    location_uuid: '<string>',
    logging: true,
    fairmode: false,
    software: 'ABB',
    name: '<string>',
    charge_point_model: '<string>',
    ssl: false,
    ip_address: '<string>',
    dns_name: '<string>',
    ip_port: 123,
    proxy_port: 123,
    manufacturer: '<string>',
    mobile_number: '<string>',
    icc_id: '<string>',
    imsi: '<string>',
    imei: '<string>',
    sim_card_name: '<string>',
    radius_pwd: '<string>',
    pin: '<string>',
    puk: '<string>',
    alternative_heartbeat_interval: 3630,
    alternative_meter_values_interval: 3630,
    alternative_ftp_host: '<string>',
    serial_number: '<string>',
    article_number: '<string>',
    u_ids: [{u_id: '<string>'}]
  })
};

fetch('https://api.chargecloud.dev/api/v1/assets/controllers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chargecloud.dev/api/v1/assets/controllers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'location_uuid' => '<string>',
    'logging' => true,
    'fairmode' => false,
    'software' => 'ABB',
    'name' => '<string>',
    'charge_point_model' => '<string>',
    'ssl' => false,
    'ip_address' => '<string>',
    'dns_name' => '<string>',
    'ip_port' => 123,
    'proxy_port' => 123,
    'manufacturer' => '<string>',
    'mobile_number' => '<string>',
    'icc_id' => '<string>',
    'imsi' => '<string>',
    'imei' => '<string>',
    'sim_card_name' => '<string>',
    'radius_pwd' => '<string>',
    'pin' => '<string>',
    'puk' => '<string>',
    'alternative_heartbeat_interval' => 3630,
    'alternative_meter_values_interval' => 3630,
    'alternative_ftp_host' => '<string>',
    'serial_number' => '<string>',
    'article_number' => '<string>',
    'u_ids' => [
        [
                'u_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chargecloud.dev/api/v1/assets/controllers"

	payload := strings.NewReader("{\n  \"location_uuid\": \"<string>\",\n  \"logging\": true,\n  \"fairmode\": false,\n  \"software\": \"ABB\",\n  \"name\": \"<string>\",\n  \"charge_point_model\": \"<string>\",\n  \"ssl\": false,\n  \"ip_address\": \"<string>\",\n  \"dns_name\": \"<string>\",\n  \"ip_port\": 123,\n  \"proxy_port\": 123,\n  \"manufacturer\": \"<string>\",\n  \"mobile_number\": \"<string>\",\n  \"icc_id\": \"<string>\",\n  \"imsi\": \"<string>\",\n  \"imei\": \"<string>\",\n  \"sim_card_name\": \"<string>\",\n  \"radius_pwd\": \"<string>\",\n  \"pin\": \"<string>\",\n  \"puk\": \"<string>\",\n  \"alternative_heartbeat_interval\": 3630,\n  \"alternative_meter_values_interval\": 3630,\n  \"alternative_ftp_host\": \"<string>\",\n  \"serial_number\": \"<string>\",\n  \"article_number\": \"<string>\",\n  \"u_ids\": [\n    {\n      \"u_id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.chargecloud.dev/api/v1/assets/controllers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"location_uuid\": \"<string>\",\n  \"logging\": true,\n  \"fairmode\": false,\n  \"software\": \"ABB\",\n  \"name\": \"<string>\",\n  \"charge_point_model\": \"<string>\",\n  \"ssl\": false,\n  \"ip_address\": \"<string>\",\n  \"dns_name\": \"<string>\",\n  \"ip_port\": 123,\n  \"proxy_port\": 123,\n  \"manufacturer\": \"<string>\",\n  \"mobile_number\": \"<string>\",\n  \"icc_id\": \"<string>\",\n  \"imsi\": \"<string>\",\n  \"imei\": \"<string>\",\n  \"sim_card_name\": \"<string>\",\n  \"radius_pwd\": \"<string>\",\n  \"pin\": \"<string>\",\n  \"puk\": \"<string>\",\n  \"alternative_heartbeat_interval\": 3630,\n  \"alternative_meter_values_interval\": 3630,\n  \"alternative_ftp_host\": \"<string>\",\n  \"serial_number\": \"<string>\",\n  \"article_number\": \"<string>\",\n  \"u_ids\": [\n    {\n      \"u_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chargecloud.dev/api/v1/assets/controllers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"location_uuid\": \"<string>\",\n  \"logging\": true,\n  \"fairmode\": false,\n  \"software\": \"ABB\",\n  \"name\": \"<string>\",\n  \"charge_point_model\": \"<string>\",\n  \"ssl\": false,\n  \"ip_address\": \"<string>\",\n  \"dns_name\": \"<string>\",\n  \"ip_port\": 123,\n  \"proxy_port\": 123,\n  \"manufacturer\": \"<string>\",\n  \"mobile_number\": \"<string>\",\n  \"icc_id\": \"<string>\",\n  \"imsi\": \"<string>\",\n  \"imei\": \"<string>\",\n  \"sim_card_name\": \"<string>\",\n  \"radius_pwd\": \"<string>\",\n  \"pin\": \"<string>\",\n  \"puk\": \"<string>\",\n  \"alternative_heartbeat_interval\": 3630,\n  \"alternative_meter_values_interval\": 3630,\n  \"alternative_ftp_host\": \"<string>\",\n  \"serial_number\": \"<string>\",\n  \"article_number\": \"<string>\",\n  \"u_ids\": [\n    {\n      \"u_id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "controller": {
    "uuid": "<string>",
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25",
    "status": "Available",
    "location_uuid": "<string>",
    "logging": true,
    "fairmode": false,
    "software": "ABB",
    "name": "<string>",
    "backend_communication_type": "ocpp_1_5",
    "mobile_communication_type": "DSL",
    "modification_date": "2023-12-25",
    "firmware_version": "<string>",
    "charge_point_model": "<string>",
    "ssl": false,
    "ip_address": "<string>",
    "dns_name": "<string>",
    "ip_port": 123,
    "proxy_port": 123,
    "manufacturer": "<string>",
    "mobile_number": "<string>",
    "icc_id": "<string>",
    "imsi": "<string>",
    "imei": "<string>",
    "sim_card_name": "<string>",
    "radius_pwd": "<string>",
    "pin": "<string>",
    "puk": "<string>",
    "alternative_heartbeat_interval": 3630,
    "alternative_meter_values_interval": 3630,
    "alternative_ftp_host": "<string>",
    "serial_number": "<string>",
    "article_number": "<string>",
    "u_ids": [
      {
        "u_id": "<string>"
      }
    ]
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "errors": [
    {
      "errorKey": "<string>",
      "message": "<string>",
      "parameter": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

api

assets

controllers

Creates a controller

curl --request POST \
  --url https://api.chargecloud.dev/api/v1/assets/controllers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_uuid": "<string>",
  "logging": true,
  "fairmode": false,
  "software": "ABB",
  "name": "<string>",
  "charge_point_model": "<string>",
  "ssl": false,
  "ip_address": "<string>",
  "dns_name": "<string>",
  "ip_port": 123,
  "proxy_port": 123,
  "manufacturer": "<string>",
  "mobile_number": "<string>",
  "icc_id": "<string>",
  "imsi": "<string>",
  "imei": "<string>",
  "sim_card_name": "<string>",
  "radius_pwd": "<string>",
  "pin": "<string>",
  "puk": "<string>",
  "alternative_heartbeat_interval": 3630,
  "alternative_meter_values_interval": 3630,
  "alternative_ftp_host": "<string>",
  "serial_number": "<string>",
  "article_number": "<string>",
  "u_ids": [
    {
      "u_id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.chargecloud.dev/api/v1/assets/controllers"

payload = {
    "location_uuid": "<string>",
    "logging": True,
    "fairmode": False,
    "software": "ABB",
    "name": "<string>",
    "charge_point_model": "<string>",
    "ssl": False,
    "ip_address": "<string>",
    "dns_name": "<string>",
    "ip_port": 123,
    "proxy_port": 123,
    "manufacturer": "<string>",
    "mobile_number": "<string>",
    "icc_id": "<string>",
    "imsi": "<string>",
    "imei": "<string>",
    "sim_card_name": "<string>",
    "radius_pwd": "<string>",
    "pin": "<string>",
    "puk": "<string>",
    "alternative_heartbeat_interval": 3630,
    "alternative_meter_values_interval": 3630,
    "alternative_ftp_host": "<string>",
    "serial_number": "<string>",
    "article_number": "<string>",
    "u_ids": [{ "u_id": "<string>" }]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    location_uuid: '<string>',
    logging: true,
    fairmode: false,
    software: 'ABB',
    name: '<string>',
    charge_point_model: '<string>',
    ssl: false,
    ip_address: '<string>',
    dns_name: '<string>',
    ip_port: 123,
    proxy_port: 123,
    manufacturer: '<string>',
    mobile_number: '<string>',
    icc_id: '<string>',
    imsi: '<string>',
    imei: '<string>',
    sim_card_name: '<string>',
    radius_pwd: '<string>',
    pin: '<string>',
    puk: '<string>',
    alternative_heartbeat_interval: 3630,
    alternative_meter_values_interval: 3630,
    alternative_ftp_host: '<string>',
    serial_number: '<string>',
    article_number: '<string>',
    u_ids: [{u_id: '<string>'}]
  })
};

fetch('https://api.chargecloud.dev/api/v1/assets/controllers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chargecloud.dev/api/v1/assets/controllers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'location_uuid' => '<string>',
    'logging' => true,
    'fairmode' => false,
    'software' => 'ABB',
    'name' => '<string>',
    'charge_point_model' => '<string>',
    'ssl' => false,
    'ip_address' => '<string>',
    'dns_name' => '<string>',
    'ip_port' => 123,
    'proxy_port' => 123,
    'manufacturer' => '<string>',
    'mobile_number' => '<string>',
    'icc_id' => '<string>',
    'imsi' => '<string>',
    'imei' => '<string>',
    'sim_card_name' => '<string>',
    'radius_pwd' => '<string>',
    'pin' => '<string>',
    'puk' => '<string>',
    'alternative_heartbeat_interval' => 3630,
    'alternative_meter_values_interval' => 3630,
    'alternative_ftp_host' => '<string>',
    'serial_number' => '<string>',
    'article_number' => '<string>',
    'u_ids' => [
        [
                'u_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chargecloud.dev/api/v1/assets/controllers"

	payload := strings.NewReader("{\n  \"location_uuid\": \"<string>\",\n  \"logging\": true,\n  \"fairmode\": false,\n  \"software\": \"ABB\",\n  \"name\": \"<string>\",\n  \"charge_point_model\": \"<string>\",\n  \"ssl\": false,\n  \"ip_address\": \"<string>\",\n  \"dns_name\": \"<string>\",\n  \"ip_port\": 123,\n  \"proxy_port\": 123,\n  \"manufacturer\": \"<string>\",\n  \"mobile_number\": \"<string>\",\n  \"icc_id\": \"<string>\",\n  \"imsi\": \"<string>\",\n  \"imei\": \"<string>\",\n  \"sim_card_name\": \"<string>\",\n  \"radius_pwd\": \"<string>\",\n  \"pin\": \"<string>\",\n  \"puk\": \"<string>\",\n  \"alternative_heartbeat_interval\": 3630,\n  \"alternative_meter_values_interval\": 3630,\n  \"alternative_ftp_host\": \"<string>\",\n  \"serial_number\": \"<string>\",\n  \"article_number\": \"<string>\",\n  \"u_ids\": [\n    {\n      \"u_id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.chargecloud.dev/api/v1/assets/controllers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"location_uuid\": \"<string>\",\n  \"logging\": true,\n  \"fairmode\": false,\n  \"software\": \"ABB\",\n  \"name\": \"<string>\",\n  \"charge_point_model\": \"<string>\",\n  \"ssl\": false,\n  \"ip_address\": \"<string>\",\n  \"dns_name\": \"<string>\",\n  \"ip_port\": 123,\n  \"proxy_port\": 123,\n  \"manufacturer\": \"<string>\",\n  \"mobile_number\": \"<string>\",\n  \"icc_id\": \"<string>\",\n  \"imsi\": \"<string>\",\n  \"imei\": \"<string>\",\n  \"sim_card_name\": \"<string>\",\n  \"radius_pwd\": \"<string>\",\n  \"pin\": \"<string>\",\n  \"puk\": \"<string>\",\n  \"alternative_heartbeat_interval\": 3630,\n  \"alternative_meter_values_interval\": 3630,\n  \"alternative_ftp_host\": \"<string>\",\n  \"serial_number\": \"<string>\",\n  \"article_number\": \"<string>\",\n  \"u_ids\": [\n    {\n      \"u_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chargecloud.dev/api/v1/assets/controllers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"location_uuid\": \"<string>\",\n  \"logging\": true,\n  \"fairmode\": false,\n  \"software\": \"ABB\",\n  \"name\": \"<string>\",\n  \"charge_point_model\": \"<string>\",\n  \"ssl\": false,\n  \"ip_address\": \"<string>\",\n  \"dns_name\": \"<string>\",\n  \"ip_port\": 123,\n  \"proxy_port\": 123,\n  \"manufacturer\": \"<string>\",\n  \"mobile_number\": \"<string>\",\n  \"icc_id\": \"<string>\",\n  \"imsi\": \"<string>\",\n  \"imei\": \"<string>\",\n  \"sim_card_name\": \"<string>\",\n  \"radius_pwd\": \"<string>\",\n  \"pin\": \"<string>\",\n  \"puk\": \"<string>\",\n  \"alternative_heartbeat_interval\": 3630,\n  \"alternative_meter_values_interval\": 3630,\n  \"alternative_ftp_host\": \"<string>\",\n  \"serial_number\": \"<string>\",\n  \"article_number\": \"<string>\",\n  \"u_ids\": [\n    {\n      \"u_id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "controller": {
    "uuid": "<string>",
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25",
    "status": "Available",
    "location_uuid": "<string>",
    "logging": true,
    "fairmode": false,
    "software": "ABB",
    "name": "<string>",
    "backend_communication_type": "ocpp_1_5",
    "mobile_communication_type": "DSL",
    "modification_date": "2023-12-25",
    "firmware_version": "<string>",
    "charge_point_model": "<string>",
    "ssl": false,
    "ip_address": "<string>",
    "dns_name": "<string>",
    "ip_port": 123,
    "proxy_port": 123,
    "manufacturer": "<string>",
    "mobile_number": "<string>",
    "icc_id": "<string>",
    "imsi": "<string>",
    "imei": "<string>",
    "sim_card_name": "<string>",
    "radius_pwd": "<string>",
    "pin": "<string>",
    "puk": "<string>",
    "alternative_heartbeat_interval": 3630,
    "alternative_meter_values_interval": 3630,
    "alternative_ftp_host": "<string>",
    "serial_number": "<string>",
    "article_number": "<string>",
    "u_ids": [
      {
        "u_id": "<string>"
      }
    ]
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "errors": [
    {
      "errorKey": "<string>",
      "message": "<string>",
      "parameter": "<string>"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

OAuth2 Bearer Authorization

Body

application/json

Creates a controller. Required permission: asset:controllers:create

location_uuid

string

required

The UUID of the location this controller is assigned to. A controller must always be linked to exactly one location and cannot be reassigned after creation.

Pattern: ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$

logging

boolean

default:true

required

Controls whether OCPP message logging is enabled for this controller. When enabled, all messages exchanged between the controller and the ChargeCloud backend are recorded.

fairmode

boolean

default:false

required

Indicates whether fair-mode load balancing is enabled for this controller. When active, available power is distributed evenly across all connected charge points

software

enum<string>

required

The software type used by this controller, selected per manufacturer. This information is required for firmware update management and must match the actual hardware configuration.

Available options:

mennekes,

mennekes_ecu,

mennekes_amtron_non_eichrecht,

mennekes_amedio_eichrecht,

mennekes_amedio_non_eichrecht,

mennekes_4you_500,

mennekes_4business_700,

mennekes_4business_700_eichrecht,

nidec,

ebg,

phoenix,

ecotap,

abb,

abb_terra_ac,

alfen,

amperfied,

ampure,

hubject,

kathrein,

keba,

kostad_sissy2,

heliox,

innogy,

ochp,

ebee,

enercharge,

chargeamps,

schneiderelectric,

tritium,

walther,

vinci_proxy,

vestel,

volkswagen,

chargehere,

schrack,

ebemobility,

kostad,

circontrol,

eluminocity,

abl,

abl_em4,

bauer_gen3,

bauer_gen4,

gewiss,

getpower,

delta,

photon,

porsche,

powerjames,

ads_tec,

siemens,

siemens_sicharge_d,

smight,

aixacct,

alpitronic,

stoehr,

meenergy,

whbcharging,

starchargeaurora,

compleo_solo,

evboxdc,

evboxliviqo,

unknown,

smappee,

hager_witty_share,

hager_witty_park,

hager_witty_pro,

zaptec,

peblar,

rzb,

kempower,

spelsberg

Example:

"ABB"

name

string

required

The name of the controller, which must exactly match the chargeBoxIdentity configured on the physical device. Avoid mixed case, umlauts, special characters, or spaces. Use underscores instead. Maximum recommended length is 20 characters per the OCPP specification.

Maximum string length: 50

backend_communication_type

enum<string>

required

The protocol and transport type used for communication between the controller and the ChargeCloud backend (e.g. OCPP 1.6 JSON, OCPP 2.0.1, or manufacturer-specific protocols such as MENNEKES_BINARY). Must match the configuration on the physical device.

Available options:

ocpp_1_5,

ocpp_1_6_soap,

ocpp_1_6_json,

ocpp_1_6_json_v2,

ocpp_201_json

mobile_communication_type

enum<string>

required

The mobile network standard used by the controller's SIM card for data transmission (e.g., GSM, LTE).

Available options:

DSL,

GSM,

WLAN

charge_point_model

string

The hardware model designation of the charging station. Can be found on the purchase receipt, in the station's documentation, or via the serial number in the boot notification.

Maximum string length: 20

ssl

boolean

default:false

Indicates whether the controller communicates with the backend over an SSL-encrypted connection. Not required for OCPP 1.6 JSON connections; mandatory for all other backend communication types.

ip_address

string

The IP address used to reach the controller. If an ICC-ID is provided, this value is assigned automatically from the linked SIM card configuration.

dns_name

string

The DNS hostname of the controller, used as an alternative to a static IP address for backend connectivity.

ip_port

integer<int64>

The IP port on which the controller accepts incoming connections. Required for direct IP-based communication setups.

proxy_port

integer<int64>

The port used when the controller communicates through a proxy server. Only relevant in network environments where direct connections are not available.

manufacturer

string

The name of the hardware manufacturer of the controller. Used for internal documentation and device management.

mobile_number

string

The mobile phone number associated with the controller's SIM card.

Maximum string length: 25

icc_id

string

The Integrated Circuit Card Identifier (ICC-ID) of the SIM card installed in the controller. When set, the system automatically assigns the corresponding IP address to the controller.

Maximum string length: 25

imsi

string

The International Mobile Subscriber Identity (IMSI) of the SIM card.

Maximum string length: 30

imei

string

The International Mobile Equipment Identity (IMEI) of the controller's modem.

Maximum string length: 30

sim_card_name

string

A label for the SIM card installed in the controller.

Maximum string length: 50

radius_pwd

string

The RADIUS authentication password associated with the controller's SIM card. Required in network environments that use RADIUS-based access control.

Maximum string length: 50

string

The PIN code of the SIM card installed in the controller. Required to unlock the SIM card on boot if PIN protection is enabled.

Maximum string length: 5

puk

string

The PUK (Personal Unblocking Key) of the SIM card. Used to unlock the SIM card if it has been blocked after multiple incorrect PIN attempts.

Maximum string length: 8

alternative_heartbeat_interval

integer<int64>

An optional override for the global heartbeat interval, in seconds. Defines how frequently the controller sends a heartbeat signal to the backend. The recommended value is 900 seconds (every 15 minutes). Min: 60, Max: 7200. Note: not applicable for OCPP 1.6 JSON controllers.

Required range: 60 <= x <= 7200

alternative_meter_values_interval

integer<int64>

An optional override for the global meter values interval, in seconds. Defines how frequently the controller transmits energy meter readings to the backend. Min: 60, Max: 7200.

Required range: 60 <= x <= 7200

alternative_ftp_host

string

An optional alternative FTP server address used for firmware update delivery. If not set, the system uses the globally configured default FTP host.

Maximum string length: 55

serial_number

string

The manufacturer-assigned serial number of the controller hardware.

Maximum string length: 16

article_number

string

The manufacturer's article or part number for this controller model.

Maximum string length: 16

u_ids

object[]

A list of RFID UIDs that are explicitly authorized to use the charge points connected to this controller. Only relevant when whitelist_only is enabled. Only cards whose UIDs appear in this list will be granted access.

Show child attributes

Response

Controller created

controller

object

required

Controller

Show child attributes

Getting started - Core

Core API

Creates a controller

Authorizations

Body

Response