Documentation

EVSE Controllers

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

EVSE Controllers Management

POST/1/evse-controllers

Create EVSE Controller

Authorization
User sessionAPI credential
Permissions
evse-controllers:write
OAuth
-
Request
Request bodyapplication/json
accessGroupIdsstring[]
accountIdstring
billingPlanIdstring
connectorsobject[]

Each connectorId must be unique within the array.

_idstring
accessGroupIdsstring[]
connectorIdintegerREQUIRED
min 1
evseIdstring | null

eMI3 identifier (e.g. NLEFLEV1234567), optionally with * separators.

evseIdModestring
autocustom
formatstring
CABLESOCKET
maxAmperagenumber
min 0
maxVoltagenumber
min 0
operatorTariffIdsstring[]
physicalReferencestring | null
powerTypestring
AC_1_PHASEAC_3_PHASEDC
standardstring
CATARCCHADEMODOMESTIC_BDOMESTIC_EDOMESTIC_FIEC_62196_T1IEC_62196_T1_COMBOIEC_62196_T2IEC_62196_T2_COMBOIEC_62196_T3AIEC_62196_T3C
tariffIdstring | null
costSettingsobject[]
_idstring
componentsobject[]
costSettingsobjectREQUIRED
idleGracePeriodMinutesnumber
pricePerHournumber
min 0
pricePerIdleMinutenumber
min 0
pricePerKwhnumber
min 0
pricePerSessionnumber
min 0
restrictionsobject
daysOfWeekstring[] | null
endDateobject | null
endTimeobject | null
maxDurationSecondsnumber | null
minDurationSecondsnumber | null
startDateobject | null
startTimeobject | null
connectorIdnumberREQUIRED
currencystring
enableEnergyMarketTrackingboolean
default false
idleGracePeriodMinutesnumber
maxPricePerKwhnumber
min 0
pricePerHournumber
min 0
pricePerIdleMinutenumber
min 0
pricePerKwhnumber
min 0
pricePerSessionnumber
min 0
surchargePerKwhnumber
min 0
surchargePercentagenumber
min 0max 100
tariffIdstring
descriptionstring
enablePublicChargingboolean
enablePublicFreeChargingboolean
enableTariffProfileOverrideboolean
evseIdstring
evseIdModestring
default auto
evseOperationalStatusIdstring
firmwareVersionstring
iccidstring
imsistring
labelsstring[]
locationIdstring
maintenanceAccountIdstring
modelNumberstring
namestring
ocppAuthorizationMethodstring
ocppIdentitystring
optOutOfScanToPayboolean
pairedChargeCardIdstring | null
serialNumberstring
smartChargingobject
methodstring
pairingCodestring | null
tariffProfileIdstring
vendorNamestring
Responses
200OK application/json
dataEvseController
accessGroupIdsstring[]
accessGroupIdsHistoryAccessGroupIdHistory[]
_idstringREQUIRED
accessGroupIdstringREQUIRED
createdAtstring <date-time>
deletedAtstring <date-time>
accountIdstring
activatedAtstring <date-time>
authorizationInfoEvseAuthenticationAttempt
authenticationMethodstring
basicclient_certificatenone
errorEvseAuthenticationError
messagestringREQUIRED
lastAttemptedAtstring <date-time>
statestring
errorskippedsuccess
banReasonstring
bannedboolean
bannedAtstring <date-time>
billingPlanIdstring
bootInfoBootNotificationRequest
chargeBoxSerialNumberstring
chargePointModelstringREQUIRED
chargePointSerialNumberstring
chargePointVendorstringREQUIRED
firmwareVersionstring
iccidstring
imsistring
meterSerialNumberstring
meterTypestring
bootInfoSerialNumbersobject[]
lastBootedAtstring <date-time>REQUIRED
serialNumberstringREQUIRED
configurationEvseControllerConfigurationItem[]
componentobject
instancestring
namestringREQUIRED
connectorIdnumber
evseIdnumber
keystringREQUIRED
readonlybooleanREQUIRED
valueobjectREQUIRED
variableobject
instancestring
namestringREQUIRED
configurationChangedAtstring <date-time>
configurationFetchedAtstring <date-time>
configurationRequestIdnumber
configureSecureConnectionSyncEvseControllerSyncMetadata
executionIdstringREQUIRED
statusstringREQUIRED
CompletedFailedInProgress
statusDetailsstring
connectionProtocolstring
soapwswss
connectionTypestring
privatepublic
connectivityStatestring
access-deniedconnecteddisconnectedmaybe-connectedpending-first-connectionunknown
connectivityStateUpdatedAtstring <date-time>
connectorStatusobject
connectorStatusAtDisconnectobject
connectorsEvseControllerConnector[]REQUIRED
_idstringREQUIRED
accessGroupIdsstring[]
amperagenumber
connectorIdnumberREQUIRED
evseIdstring
evseIdModestring
autocustom
formatstring
maxAmperagenumber
maxPowernumber
maxVoltagenumber
ocppConnectorIdnumber
ocppEvseIdnumber
operatorTariffIdsstring[]

operator platform tariffs associated with connector for most cases this value should contain only one tariff, but some connectors could have more than one tariff

paymentTerminalIdsstring[]
physicalReferencestring

a human-readable label for visual identification

powerTypestring
standardstring
tariffIdstring

This field is used for Roaming purposes

connectorsHistoryEvseControllerConnectorHistoryEntry[]
connectorObjectIdstringREQUIRED
createdAtstring <date-time>REQUIRED
deletedAtstring <date-time>
fulfilledAtstring <date-time>
powerTypestring
coordinatorConnectedAtstring <date-time>
coordinatorDisconnectedAtstring <date-time>
coordinatorStatusobject
connectionInfoobject
hoststring
protocolstring
remoteAddressstring
identifierstring
statestring
websocketIdnumber
costSettingsEvseTariff[]
clampAfterFixedSurchargeboolean
componentsAdvancedTariffRestrictedCostSettings[]
costSettingsobjectREQUIRED
restrictionsAdvancedTariffRestrictionsREQUIRED
connectorIdnumberREQUIRED
currencystringREQUIRED
enableEnergyMarketTrackingboolean
idleGracePeriodMinutesnumber
idleV2boolean
maxPricePerKwhnumber
maxTotalCostnumber
pricePerHournumber
pricePerIdleMinutenumber
pricePerKwhnumber
pricePerSessionnumber
surchargePerKwhnumber
surchargePercentagenumber
tariffIdstringREQUIRED
timelineV2boolean
createdAtstring <date-time>REQUIRED
createdByMethodstring
connectiondraft
deletedboolean
descriptionstring
diagnosticsRequestedAtstring <date-time>
disableRoamingChargeForProvidersboolean
disableRoamingChargePartyIdsstring[]
enablePublicChargingboolean
enablePublicFreeChargingboolean
enableTariffProfileOverrideboolean
evseIdstring
evseIdModestring
autocustom
evseIdRefstring
evseOperationalStatusEvseOperationalStatus
badgeColorstringREQUIRED
blackbluebrowngreengreyoliveorangepinkpurpleredtealvioletyellow
billingStatusstringREQUIRED
disabledenablednone
canonicalStatusstring

Only present for system status

activationarchivedliveonboardingoutOfService
chargingStationStatusstringREQUIRED
inoperativenoneoperative
createdAtstring <date-time>REQUIRED
deletedbooleanREQUIRED
deletedAtstring <date-time>
descriptionstringREQUIRED
idstringREQUIRED
isInitialbooleanREQUIRED
isPrimaryboolean

Only present for custom status with parent. Indicates the primary alias used for automatic transitions.

namestringREQUIRED
parentEvseOperationalStatusEvseOperationalStatus
parentEvseOperationalStatusIdstring

Only present for custom status with parent

providerIdstring

Only present for custom status

roamingStatusstringREQUIRED
blockedinoperativenoneoutOfOrderplannedremovedreserved
typestringREQUIRED
customsystem
updatedAtstring <date-time>REQUIRED
evseOperationalStatusIdstringREQUIRED
firmwareUploadobject
heartbeatReceivedAtstring <date-time>
idstringREQUIRED
importsobject
importIdsstring[]REQUIRED
referencestringREQUIRED
isBillingEnabledboolean
isDisabledboolean
labelsstring[]
lastActivityAtstring <date-time>
lastBootedAtstring <date-time>
lastConnectivityModestring
locationIdstring
maintenanceAccountIdstring
maxPowernumber
namestring
normalizedEvseIdstring
numConnectorsnumber
numericIdentitynumber
ocppAuthorizationKeystring
ocppAuthorizationMethodstring
basicclient_certificatenone
ocppChargingStationIdstring
ocppFtpPasswordstring
ocppIdentitystring
ocppProtocolVersionstring
opChargingStationIdstring
operatorPlatformEnrollmentstring
enrolledenrolled-tariff-onlyenrolled-with-shadow-modenot-enrolled
optOutOfScanToPayboolean
pairedChargeCardCard
accountIdstringREQUIRED
billingPlanChangeContextstring
billingPlanChangedAtstring <date-time>
billingPlanIdstringREQUIRED
cancelledboolean
cancelledAtstring <date-time>
cancelledReasonstring
createdAtstring <date-time>
deletedboolean
deletedAtstring <date-time>
deliveryCardDelivery
addressstringREQUIRED
addressLine2stringREQUIRED
citystringREQUIRED
countryCodestringREQUIRED
firstNamestringREQUIRED
lastNamestringREQUIRED
notesstring
postalCodestringREQUIRED
externalPaymentExternalPayment
authorizedAmountBSONMoney
capturedAmountBSONMoney
displayIdentifierstring
failureReasonstring
paymentIdstring
paymentInstrumentIdstring
paymentMethodstring
statusstringREQUIRED
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDED
systemIdstringREQUIRED
payBridge
fleetIdstring

The fleet the card's token belongs to. Kept in step with the token, never set on its own.

idstringREQUIRED
migrationAtstring <date-time>
migrationIdstring
mspPaymentMSPPaymentCard
cardCostsAmountBSONMoneyREQUIRED
paymentReceiptIdstring
totalAmountBSONMoneyREQUIRED
vatInfoVatRule
nameOnCardstring
providerIdstringREQUIRED
requestUserboolean
requestUserEmailstring
requestUserFirstNamestring
requestUserLastNamestring
statusstringREQUIRED
activedisabledpendingpending-activationpending-paymentsent
tokenAssignedAtstring <date-time>
tokenIdstring
typestringREQUIRED
cardtagvirtual
updatedAtstring <date-time>
userIdstringREQUIRED
pairedChargeCardIdstringREQUIRED
pairedChargeCardSyncEvseControllerSyncMetadata
executionIdstringREQUIRED
statusstringREQUIRED
CompletedFailedInProgress
statusDetailsstring
previousProviderIdsstring[]
providerIdstringREQUIRED
publicKeysobject[]
connectorIdnumberREQUIRED
keystringREQUIRED
rebootRequiredbooleanREQUIRED
renewBasicAuthPasswordSyncEvseControllerRenewBasicAuthMetadata
executionIdstringREQUIRED
newPasswordHashstring
statusstringREQUIRED
CompletedFailedInProgress
statusDetailsstring
salesforceIdstring
securityPolicyEvseSecurityPolicy
securityProfilenumberREQUIRED
serialNumberstring
setupFinishedboolean
setupProgressstringREQUIRED
ATTACH_ENTITIESCOMPLETEDCONFIGURE_CONNECTOR_INFOCONFIGURE_ENERGY_COSTSCONFIGURE_NUMBER_OF_CONNECTORS
simpleSerialNumberstring
smartChargingSmartChargingConfiguration
methodstringREQUIRED
nonestekker
statusstring
tariffProfileIdstring
tokenAuthorizeReceivedAtstring <date-time>
uidstring
unlockConnectorSyncUnlockConnectorSyncMetadata
executionIdstringREQUIRED
failedReasonstring
not_supportedongoing_authorized_transactionrejectedunknown_connectorunlock_failedunspecified
statusstringREQUIRED
CompletedFailedInProgress
statusDetailsstring
updatedAtstring <date-time>REQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/1/evse-controllers/available-operational-statuses

List Available EVSE Operational Statuses

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Responses
200OK application/json
dataobject[]
availablebooleanREQUIRED
badgeColorstringREQUIRED
blackbluebrowngreengreyoliveorangepinkpurpleredtealvioletyellow
billingStatusstringREQUIRED
disabledenablednone
canonicalStatusstring

Only present for system status

activationarchivedliveonboardingoutOfService
chargingStationStatusstringREQUIRED
inoperativenoneoperative
createdAtstring <date-time>REQUIRED
deletedbooleanREQUIRED
deletedAtstring <date-time>
descriptionstringREQUIRED
idstringREQUIRED
isInitialbooleanREQUIRED
isPrimaryboolean

Only present for custom status with parent. Indicates the primary alias used for automatic transitions.

namestringREQUIRED
parentEvseOperationalStatusEvseOperationalStatus
badgeColorstringREQUIRED
blackbluebrowngreengreyoliveorangepinkpurpleredtealvioletyellow
billingStatusstringREQUIRED
disabledenablednone
canonicalStatusstring

Only present for system status

activationarchivedliveonboardingoutOfService
chargingStationStatusstringREQUIRED
inoperativenoneoperative
createdAtstring <date-time>REQUIRED
deletedbooleanREQUIRED
deletedAtstring <date-time>
descriptionstringREQUIRED
idstringREQUIRED
isInitialbooleanREQUIRED
isPrimaryboolean

Only present for custom status with parent. Indicates the primary alias used for automatic transitions.

namestringREQUIRED
parentEvseOperationalStatusEvseOperationalStatus
parentEvseOperationalStatusIdstring

Only present for custom status with parent

providerIdstring

Only present for custom status

roamingStatusstringREQUIRED
blockedinoperativenoneoutOfOrderplannedremovedreserved
typestringREQUIRED
customsystem
updatedAtstring <date-time>REQUIRED
parentEvseOperationalStatusIdstring

Only present for custom status with parent

providerIdstring

Only present for custom status

roamingStatusstringREQUIRED
blockedinoperativenoneoutOfOrderplannedremovedreserved
typestringREQUIRED
customsystem
updatedAtstring <date-time>REQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/evse-controllers/reliability-report

EVSE Reliability Report

The reliability metrics are computed from aggregated connector status changes collected over time. This endpoint requires the analytics:account platform feature to be enabled for the account.

Authorization
User sessionAPI credential
Permissions
evse-controllers:read
OAuth
-
Request
Request bodyapplication/json
accountIdstring
exportRangeobject
fromstring <date-time>REQUIRED
tostring <date-time>REQUIRED
filtersobject
accountIdsstring[]
billingPlansstring[]
connectivityStatestring
connectivityStatesstring[]
createdAtobject
$gtestring <date-time>
$ltestring <date-time>
evseOperationalStatusIdsstring[]
firmwareVersionsstring[]
hasNoAccountboolean
importIdstring
labelsstring[]
locationIdsstring[]
maintenanceAccountsstring[]
ocppVersionsstring[]
orderstring
powerTypestring
ACACDCDC
readyForActivationboolean
searchPhrasestring
setupInProgressboolean
setupStatesstring[]
tariffProfilestring
tariffProfilesstring[]
vendorsstring[]
formatstring
csvjson
default json
granularitystring
monthyear
limitnumber
default 100
skipnumber
default 0
sortobject
fieldstring
orderstring
Responses
200OK application/json
dataReliabilityReportItem[]REQUIRED
accountNamestringREQUIRED
availablenumberREQUIRED
availableMinutesnumberREQUIRED
blockednumberREQUIRED
blockedMinutesnumberREQUIRED
chargingnumberREQUIRED
chargingMinutesnumberREQUIRED
chargingStationEvseIdstringREQUIRED
connectorEvseIdstringREQUIRED
euidstringREQUIRED
inoperativenumberREQUIRED
inoperativeMinutesnumberREQUIRED
locationstringREQUIRED
maxPowernumberREQUIRED
monthstringREQUIRED
ocppIdstringREQUIRED
outOfOrdernumberREQUIRED
outOfOrderMinutesnumberREQUIRED
plannednumberREQUIRED
plannedMinutesnumberREQUIRED
powerTypestringREQUIRED
removednumberREQUIRED
removedMinutesnumberREQUIRED
reservednumberREQUIRED
reservedMinutesnumberREQUIRED
standardstringREQUIRED
unknownnumberREQUIRED
unknownMinutesnumberREQUIRED
unspecifiednumberREQUIRED
unspecifiedMinutesnumberREQUIRED
yearnumberREQUIRED
metaobjectREQUIRED
fromstringREQUIRED
granularitystringREQUIRED
tostringREQUIRED
totalnumberREQUIRED
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/evse-controllers/search/fast

Search EVSE Controllers

Fast search EVSE Controllers.

Authorization
User sessionAPI credential
Permissions
evse-controllers:read
OAuth
-
Request
Request bodyapplication/json
accountIdstring
accountIdsstring[]
billingPlansstring[]
chargingGroupIdsstring <uuid>[]
connectivityStatestring
connectivityStatesstring[]
connectorStatusesstring[]
connectorTypesstring[]
createdAtobject
$gtestring <date-time>
$ltestring <date-time>
evseOperationalStatusIdsstring[]
facilitatorAccountsstring[]
firmwareVersionsstring[]
hasNoAccountboolean
importIdstring
labelsstring[]
limitnumber
default 100
locationIdsstring[]
maintenanceAccountsstring[]
ocppVersionsstring[]
onlyWithConnectorsboolean
opChargingStationIdsstring[]
operatorPlatformEnrollmentsstring[]
orderstring
powerTypestring
ACACDCDC
powerTypesstring[]
readyForActivationboolean
searchPhrasestring
setupInProgressboolean
setupStatesstring[]
skipnumber
default 0
sortobject
fieldstring
orderstring
tariffProfilestring
tariffProfilesstring[]
vendorsstring[]
Responses
200OK application/json
dataEvseControllerFastSearch[]
accountobject
namestring
accountIdstring
activatedAtstring <date-time>
authorizationInfoobject
lastAttemptedAtstring <date-time>
statestring
billingPlanobject
namestring
billingPlanIdstring
bootInfoobject
chargePointModelstring
chargePointVendorstring
firmwareVersionstring
iccidstring
imsistring
connectivityStatestring
access-deniedconnecteddisconnectedmaybe-connectedpending-first-connectionunknown
connectivityStateUpdatedAtstring <date-time>
connectorStatusEvseControllerConnectorStatusFastSearch[]
connectorIdnumberREQUIRED
statusstring
connectorsEvseControllerConnectorFastSearch[]
evseIdstring
formatstring
idstring
maxAmperagenumber
maxVoltagenumber
powerTypestring
standardstring
tariffIdstring
coordinatorConnectedAtstring <date-time>
coordinatorDisconnectedAtstring <date-time>
createdAtstring <date-time>
evseIdstring
evseOperationalStatusobjectREQUIRED
badgeColorstringREQUIRED
createdAtstring <date-time>REQUIRED
namestringREQUIRED
typestringREQUIRED
updatedAtstring <date-time>REQUIRED
evseOperationalStatusIdstringREQUIRED
heartbeatReceivedAtstring <date-time>
idstringREQUIRED
isBillingEnabledboolean
labelsstring[]
locationobject
addressstring
citystring
namestring
postal_codestring
userIdstring
locationIdstring
maintenanceAccountobject
namestring
maintenanceAccountIdstring
namestring
normalizedEvseIdstring
numericIdentitynumber
ocppChargingStationIdstringREQUIRED
ocppIdentitystring
ocppProtocolVersionstring
opChargingStationIdstring
providerIdstring
readyForActivationboolean
serialNumberstring
setupInProgressboolean
setupProgressobject
currentStepnumber
statestring
simpleSerialNumberstring
tariffProfileIdstring
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/1/evse-controllers/{evseController}

Get EVSE Controller by ID

Authorization
User sessionAPI credential
Permissions
evse-controllers:read
OAuth
-
Request
Path parameters1
evseControllerstringREQUIRED
Responses
200OK application/json
dataEvseControllerResource
accessGroupIdsstring[]
accessGroupsobject[]
accountobject
accountIdstring
billingPlanobject
billingPlanIdstring
bootInfoobject
configurationEvseControllerConfigurationItem[]
componentobject
instancestring
namestringREQUIRED
connectorIdnumber
evseIdnumber
keystringREQUIRED
readonlybooleanREQUIRED
valueobjectREQUIRED
variableobject
instancestring
namestringREQUIRED
configurationFetchedAtstring
connectivityStatestring
connectorStatusobject
connectorsobject[]
coordinatorStatusobject
costSettingsobject[]
createdAtstringREQUIRED
descriptionstring
enablePublicChargingboolean
enablePublicFreeChargingboolean
enableTariffProfileOverrideboolean
evseIdstring
evseIdModestring
evseIdRefobject
evseOperationalStatusobject
evseOperationalStatusIdstring
heartbeatReceivedAtstring
idstringREQUIRED
isDisabledboolean
isPairingChargeCardAllowedboolean
labelsstring[]
locationobject
locationIdstring
maintenanceAccountobject
maintenanceAccountIdstring
namestring
numConnectorsnumber
ocppChargingStationIdstring
ocppIdentitystring
opChargingStationIdstring
optOutOfScanToPayboolean
pairedChargeCardobject
pairedChargeCardIdstring
providerobject
providerIdstringREQUIRED
serialNumberstring
smartChargingobject
tariffProfileobject
tariffProfileIdstring
updatedAtstringREQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
PATCH/1/evse-controllers/{evseController}

Update EVSE Controller

Authorization
User sessionAPI credential
Permissions
evse-controllers:write
OAuth
-
Request
Path parameters1
evseControllerstringREQUIRED
Request bodyapplication/json
accessGroupIdsstring[]
accountIdstring
billingPlanIdstring
connectorsobject[]

Each connectorId must be unique within the array.

_idstring
accessGroupIdsstring[]
connectorIdintegerREQUIRED
min 1
evseIdstring | null

eMI3 identifier (e.g. NLEFLEV1234567), optionally with * separators.

evseIdModestring
autocustom
formatstring
CABLESOCKET
maxAmperagenumber
min 0
maxVoltagenumber
min 0
operatorTariffIdsstring[]
physicalReferencestring | null
powerTypestring
AC_1_PHASEAC_3_PHASEDC
standardstring
CATARCCHADEMODOMESTIC_BDOMESTIC_EDOMESTIC_FIEC_62196_T1IEC_62196_T1_COMBOIEC_62196_T2IEC_62196_T2_COMBOIEC_62196_T3AIEC_62196_T3C
tariffIdstring | null
costSettingsobject[]
_idstring
componentsobject[]
costSettingsobjectREQUIRED
idleGracePeriodMinutesnumber
pricePerHournumber
min 0
pricePerIdleMinutenumber
min 0
pricePerKwhnumber
min 0
pricePerSessionnumber
min 0
restrictionsobject
daysOfWeekstring[] | null
endDateobject | null
endTimeobject | null
maxDurationSecondsnumber | null
minDurationSecondsnumber | null
startDateobject | null
startTimeobject | null
connectorIdnumberREQUIRED
currencystring
enableEnergyMarketTrackingboolean
default false
idleGracePeriodMinutesnumber
maxPricePerKwhnumber
min 0
pricePerHournumber
min 0
pricePerIdleMinutenumber
min 0
pricePerKwhnumber
min 0
pricePerSessionnumber
min 0
surchargePerKwhnumber
min 0
surchargePercentagenumber
min 0max 100
tariffIdstring
descriptionstring
disableRoamingChargeForProvidersboolean
disableRoamingChargePartyIdsstring[]
enablePublicChargingboolean
enablePublicFreeChargingboolean
enableTariffProfileOverrideboolean
evseIdstring
evseOperationalStatusIdstring
firmwareVersionstring
iccidstring
imsistring
isDisabledboolean
labelsstring[]
locationIdstring
maintenanceAccountIdstring
modelNumberstring
namestring
numConnectorsnumber
ocppAuthorizationMethodstring
ocppIdentitystring
optOutOfScanToPayboolean
pairedChargeCardIdstring | null
serialNumberstring
smartChargingobject
methodstring
pairingCodestring | null
tariffProfileIdstring
vendorNamestring
Responses
200OK application/json
dataEvseControllerResource
accessGroupIdsstring[]
accessGroupsobject[]
accountobject
accountIdstring
billingPlanobject
billingPlanIdstring
bootInfoobject
configurationEvseControllerConfigurationItem[]
componentobject
instancestring
namestringREQUIRED
connectorIdnumber
evseIdnumber
keystringREQUIRED
readonlybooleanREQUIRED
valueobjectREQUIRED
variableobject
instancestring
namestringREQUIRED
configurationFetchedAtstring
connectivityStatestring
connectorStatusobject
connectorsobject[]
coordinatorStatusobject
costSettingsobject[]
createdAtstringREQUIRED
descriptionstring
enablePublicChargingboolean
enablePublicFreeChargingboolean
enableTariffProfileOverrideboolean
evseIdstring
evseIdModestring
evseIdRefobject
evseOperationalStatusobject
evseOperationalStatusIdstring
heartbeatReceivedAtstring
idstringREQUIRED
isDisabledboolean
isPairingChargeCardAllowedboolean
labelsstring[]
locationobject
locationIdstring
maintenanceAccountobject
maintenanceAccountIdstring
namestring
numConnectorsnumber
ocppChargingStationIdstring
ocppIdentitystring
opChargingStationIdstring
optOutOfScanToPayboolean
pairedChargeCardobject
pairedChargeCardIdstring
providerobject
providerIdstringREQUIRED
serialNumberstring
smartChargingobject
tariffProfileobject
tariffProfileIdstring
updatedAtstringREQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
DELETE/1/evse-controllers/{evseController}

Delete EVSE Controller

Authorization
User sessionAPI credential
Permissions
evse-controllers:write
OAuth
-
Request
Path parameters1
evseControllerstringREQUIRED
Responses
204OK text/plain
Returns a file (Text).
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/evse-controllers/{evseController}/commands

Send OCPP Command

Send an OCPP command to an EVSE Controller.

Authorization
User sessionAPI credential
Permissions
evse-commands:write
OAuth
-
Request
Path parameters1
evseControllerstringREQUIRED
Request bodyapplication/json
methodstringREQUIRED
paramsobjectREQUIRED
Responses
200OK application/json
dataobject
executionIdstringREQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/evse-controllers/{evseController}/commands/searchDEPRECATED

Search OCPP Commands

Search OCPP commands for an EVSE Controller.

Authorization
User sessionAPI credential
Permissions
evse-commands:read
OAuth
-
Rate limit
200 / 1 min
Deprecated

Deprecated since 31 July 2026. Stops working on 31 March 2027. Use POST /2/evse-controllers/{evseController}/commands/search instead.

Read the deprecation notice
Request
Path parameters1
evseControllerstringREQUIRED
Request bodyapplication/json
connectorIdnumber
createdAtobject
$eqnumber | string <date-time>
$gtenumber | string <date-time>
$ltenumber | string <date-time>
filenamestring
default commands.csv
formatstring
default json
fromstring <date-time>
hideConnectedboolean
hideHeartBeatsboolean
hideMeterValuesboolean
idsstring[]
limitnumber
default 50
methodstring[] | string
skipnumber
default 0
sortobject
default {"field":"createdAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
statusstring[] | string
tostring <date-time>
transactionIdstring
Responses
200OK application/json
dataOcppCommandResource[]
createdAtstring <date-time>
destinationstring
errorobject
idstringREQUIRED
idempotencyIdstring
messageIdstring
methodstring
ocppChargingStationIdstring
ocppIdentitystring
paramsobject
providerSlugstring
resultobject
statusstring
updatedAtstring <date-time>
versionstring
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
429Too many requests: the rate limit was exceeded application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/2/evse-controllers/{evseController}/commands/search

Search OCPP Commands (v2)

Returns the OCPP commands sent to and received from the station, newest first. There is no sort or order parameter.

This replaces the v1 search (POST /1/evse-controllers/{evseController}/commands/search), which is being retired.

{evseController} is the EVSE controller's id: a 24-character hex id, the same id used across the EVSE Controllers API.

Pagination:

  1. Make the first request without cursor.
  2. If meta.nextCursor is present, older results remain: repeat the same body with "cursor": "<meta.nextCursor>".
  3. When meta.nextCursor is absent, you have reached the end of the window.

meta.prevCursor, when present, walks back towards newer results. The rest of the body must stay identical across pages. cursor and pinnedEntry are mutually exclusive. If the pinned command is not in the result set (outside the window, filtered out, or deleted), the server falls back to page 1 rather than returning an error.

Counting is opt-in, since it costs more than fetching a page, and is attempted only on a forward fetch. Set count: true on the first request to add meta.total. isExact: true means an exact count; false means the count reached countCap and value is a lower bound. total is omitted when the result set is too large to count within the safety budget, and also when the request uses pinnedEntry or a cursor from meta.prevCursor, even if count was set. Request the count once, on the first page.

Authorization
User sessionAPI credential
Permissions
evse-commands:read
OAuth
-
Rate limit
1000 / 1 min
Request
Path parameters1
evseControllerstringREQUIRED

The EVSE controller's id: a 24-character hex id, the same id used across the EVSE Controllers API.

Request bodyapplication/json
connectorIdinteger

Filter to commands for this connector (the connector number shown on the dashboard).

countboolean

Adds meta.total to the response. Opt-in, since counting costs more than fetching a page. Request it once, on the first page.

default false
countCapinteger

The maximum value the count counts up to. When it is reached, meta.total.isExact is false and value is a lower bound.

default 10000max 100000
cursorstring

The opaque cursor from meta.nextCursor or meta.prevCursor. Cannot be combined with pinnedEntry.

filenamestring

The CSV download's file name. Used only when format is csv.

default commands.csv
formatstring

json returns one page. csv streams every matching row in the window, newest first, as a CSV download, and ignores limit, cursor, count and pinnedEntry.

csvjson
default json
fromstring <date-time>REQUIRED

Start of the search window (inclusive).

hideConnectedboolean

Exclude Connected commands.

hideHeartBeatsboolean

Exclude Heartbeat commands.

hideMeterValuesboolean

Exclude meter value readings: the OCPP 1.6 MeterValues action, and periodic metering TransactionEvents on OCPP 2.0.1/2.1.

limitnumber

Page size.

default 100max 500
methodstring[] | string

Filter by OCPP action, or a list of actions, for example BootNotification or ["StartTransaction", "StopTransaction"].

pinnedEntryobject

The sort key of one command to centre the page on, for deep links: returns the page containing this command, with a few newer rows above it and the rest older below. Cannot be combined with cursor. Ignored when format is csv.

commandIdstringREQUIRED

The id of the command to centre on.

createdAtstring <date-time>REQUIRED

The createdAt of the command to centre on.

statusstring[] | string

Filter by command status: one or more of pending, busy, done, timeout. timeout is not yet recorded; timed-out commands currently show as busy.

tostring <date-time>

End of the search window (exclusive: results have createdAt < to). Defaults to now.

transactionIdstring

Filter by OCPP transaction id.

Responses
200OK application/json
dataOcppCommandSearchRow[]REQUIRED
createdAtstring <date-time>REQUIRED
destinationstring

chargepoint means the command was sent to the station; centralsystem means it was received from the station.

errorobject

Null unless the command failed.

idstring <uuid>REQUIRED

The command's unique id.

messageIdstring
methodstringREQUIRED
ocppChargingStationIdstringREQUIRED

The charging station's id (not the EVSE controller id in the request path).

ocppIdentitystring
paramsobject
resultobject
statusstring
updatedAtstring <date-time>REQUIRED
versionstring

The OCPP version, for example ocpp1.6.

metaobjectREQUIRED
limitnumberREQUIRED
nextCursorstring

Present only when older results remain; omitted on the last page.

prevCursorstring

Cursor towards the newer end of the result set, for paging backwards. Present only when a newer page exists; omitted otherwise.

totalobject

Present only when count was requested and a count is available; omitted otherwise, including when the scan-budget cap made counting infeasible.

isExactbooleanREQUIRED

True for an exact count; false when the count reached countCap, in which case value is a lower bound.

valuenumberREQUIRED
400{evseController} is not a valid id, the body is malformed (for example limit or countCap out of range, or both cursor and pinnedEntry given), connectorId does not match a connector on this EVSE controller, the EVSE controller has no charging station, or cursor is malformed. application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Missing the evseCommands:read permission, or no access to this EVSE controller. application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404EVSE controller not found. application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
429Too many requests: the rate limit was exceeded application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
503Command search is temporarily unavailable. application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
504Command search timed out; retry, or narrow the window. application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED