gridX API Changelog

📚 API Documentation
23

Changelog 2025-04-04T07:13:19.108Z

GET /gateways

  • added the new optional ‘query’ request parameter ‘serial_number’
  • added the new optional ‘query’ request parameter ‘start_code’

(sha 95449317)

24

Changelog 2025-04-24T15:28:16.449Z

GET /clusters/{clusterID}/live

  • added the optional property ‘evChargingStation/stationState’ to the response with the ‘200’ status
  • added the optional property ‘evChargingStations/items/stationState’ to the response with the ‘200’ status

GET /systems/{systemID}/historical

  • added the optional property ‘data/items/evChargingStations/items/stationState’ to the response with the ‘200’ status
  • added the optional property ‘total/evChargingStations/items/stationState’ to the response with the ‘200’ status

GET /systems/{systemID}/live

  • added the optional property ‘evChargingStation/stationState’ to the response with the ‘200’ status
  • added the optional property ‘evChargingStations/items/stationState’ to the response with the ‘200’ status

GET /systems/{systemID}/timeofuse/settings

  • added the required property ‘excludeAssetIDs’ to the response with the ‘200’ status

PATCH /systems/{systemID}/timeofuse/settings

  • added the new optional ‘query’ request parameter ‘skipClusterCreation’
  • added the required property ‘excludeAssetIDs’ to the response with the ‘200’ status

PUT /systems/{systemID}/timeofuse/settings

  • added the new optional ‘query’ request parameter ‘skipClusterCreation’
  • added the required property ‘excludeAssetIDs’ to the response with the ‘200’ status

(sha d996ff26)

25

Changelog 2025-05-06T08:33:28.836Z

GET /health-checks

  • :warning: added the new ‘energyFlow’ enum value to the ‘checks/items/type’ response property for the response status ‘200’

POST /health-checks

  • :warning: added the new ‘energyFlow’ enum value to the ‘results/items/results/items/type’ response property for the response status ‘200’
  • added the new ‘energyFlow’ enum value to the request property ‘checks/items/type’
  • added ‘#/components/schemas/EnergyFlowCheckRequest’ to the ‘checks/items/params’ request property ‘oneOf’ list

GET /systems

  • :warning: deleted the ‘query’ request parameter ‘start_code’

(sha e2532062)

26

Changelog 2025-05-26T14:07:23.038Z

GET /accounts/{accountID}/systems

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

GET /gateways

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /gateways/{gatewayID}

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’

GET /systems

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /systems/{systemID}

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems/{systemID}/gateways

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘201’

GET /user/stars/systems

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

(sha 11eae001)

27

Changelog 2025-06-04T16:18:48.055Z

GET /accounts/{accountID}/systems

  • :warning: added the new ‘EEBUS_PAIRING’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘ENPHASE_CONNECTION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SONNEN_CONNECTION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

GET /gateways

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}

  • :warning: added the new ‘EEBUS_PAIRING’ enum value to the ‘system/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘ENPHASE_CONNECTION’ enum value to the ‘system/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SONNEN_CONNECTION’ enum value to the ‘system/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /gateways/{gatewayID}

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}/appliances

  • the response property ‘/items/oneOf[subschema #5: IO Device]/ioDevice’ became required for the status ‘200’
  • the response property ‘/items/oneOf[subschema #5: IO Device]/ioDevice/inChannelsCount’ became required for the status ‘200’
  • the response property ‘/items/oneOf[subschema #5: IO Device]/ioDevice/outChannelsCount’ became required for the status ‘200’
  • added the required property ‘/items/oneOf[subschema #4: EV Charging Station]/evChargingStation’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/appliances/{applianceID}

  • the response property ‘/oneOf[subschema #5: IO Device]/ioDevice’ became required for the status ‘200’
  • the response property ‘/oneOf[subschema #5: IO Device]/ioDevice/inChannelsCount’ became required for the status ‘200’
  • the response property ‘/oneOf[subschema #5: IO Device]/ioDevice/outChannelsCount’ became required for the status ‘200’
  • added the required property ‘/oneOf[subschema #4: EV Charging Station]/evChargingStation’ to the response with the ‘200’ status

PATCH /gateways/{gatewayID}/appliances/{applianceID}

  • the response property ‘/oneOf[subschema #5: IO Device]/ioDevice’ became required for the status ‘200’
  • the response property ‘/oneOf[subschema #5: IO Device]/ioDevice/inChannelsCount’ became required for the status ‘200’
  • the response property ‘/oneOf[subschema #5: IO Device]/ioDevice/outChannelsCount’ became required for the status ‘200’
  • added the required property ‘/oneOf[subschema #4: EV Charging Station]/evChargingStation’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • the response property ‘/items/appliances/items/oneOf[subschema #5: IO Device]/ioDevice’ became required for the status ‘200’
  • the response property ‘/items/appliances/items/oneOf[subschema #5: IO Device]/ioDevice/inChannelsCount’ became required for the status ‘200’
  • the response property ‘/items/appliances/items/oneOf[subschema #5: IO Device]/ioDevice/outChannelsCount’ became required for the status ‘200’
  • added the required property ‘/items/appliances/items/oneOf[subschema #4: EV Charging Station]/evChargingStation’ to the response with the ‘200’ status

GET /health-checks

  • added the required property ‘checks/items/profiles’ to the response with the ‘200’ status

POST /health-checks

  • added the new optional request property ‘profile’

GET /systems

  • :warning: added the new ‘EEBUS_PAIRING’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘ENPHASE_CONNECTION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SONNEN_CONNECTION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems

  • :warning: added the new ‘EEBUS_PAIRING’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘201’
  • :warning: added the new ‘ENPHASE_CONNECTION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘201’
  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘SONNEN_CONNECTION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘201’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}

  • :warning: added the new ‘EEBUS_PAIRING’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘ENPHASE_CONNECTION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SONNEN_CONNECTION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /systems/{systemID}

  • :warning: added the new ‘EEBUS_PAIRING’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘ENPHASE_CONNECTION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SONNEN_CONNECTION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems/{systemID}/gateways

  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘201’

GET /user/stars/systems

  • :warning: added the new ‘EEBUS_PAIRING’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘ENPHASE_CONNECTION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘PPC_EEBUS_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘PROLAN_EEBUS_STB’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘SONNEN_CONNECTION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘THEBEN_SE_EEBUS_METER’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VAILLANT_EEBUS_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘VIESSMANN_EEBUS_INVERTER_AND_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

(sha 9f0dbde7)

28

Changelog 2025-06-10T15:35:31.043Z

GET /accounts/{accountID}/systems

  • added the optional property ‘/items/gatewayStatus’ to the response with the ‘200’ status

GET /gateways/{gatewayID}

  • added the optional property ‘system/gatewayStatus’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/appliances

  • the response property ‘/items/oneOf[subschema #5: IO Device]/ioDevice’ became required for the status ‘200’
  • the response property ‘/items/oneOf[subschema #5: IO Device]/ioDevice/inChannelsCount’ became required for the status ‘200’
  • the response property ‘/items/oneOf[subschema #5: IO Device]/ioDevice/outChannelsCount’ became required for the status ‘200’
  • added the required property ‘/items/oneOf[subschema #4: EV Charging Station]/evChargingStation’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/appliances/{applianceID}

  • the response property ‘/oneOf[subschema #5: IO Device]/ioDevice’ became required for the status ‘200’
  • the response property ‘/oneOf[subschema #5: IO Device]/ioDevice/inChannelsCount’ became required for the status ‘200’
  • the response property ‘/oneOf[subschema #5: IO Device]/ioDevice/outChannelsCount’ became required for the status ‘200’
  • added the required property ‘/oneOf[subschema #4: EV Charging Station]/evChargingStation’ to the response with the ‘200’ status

PATCH /gateways/{gatewayID}/appliances/{applianceID}

  • the response property ‘/oneOf[subschema #5: IO Device]/ioDevice’ became required for the status ‘200’
  • the response property ‘/oneOf[subschema #5: IO Device]/ioDevice/inChannelsCount’ became required for the status ‘200’
  • the response property ‘/oneOf[subschema #5: IO Device]/ioDevice/outChannelsCount’ became required for the status ‘200’
  • added the required property ‘/oneOf[subschema #4: EV Charging Station]/evChargingStation’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/scans

  • added the new optional ‘query’ request parameter ‘page’
  • added the new optional ‘query’ request parameter ‘per_page’
  • the response property ‘/items/appliances/items/oneOf[subschema #5: IO Device]/ioDevice’ became required for the status ‘200’
  • the response property ‘/items/appliances/items/oneOf[subschema #5: IO Device]/ioDevice/inChannelsCount’ became required for the status ‘200’
  • the response property ‘/items/appliances/items/oneOf[subschema #5: IO Device]/ioDevice/outChannelsCount’ became required for the status ‘200’
  • added the required property ‘/items/appliances/items/oneOf[subschema #4: EV Charging Station]/evChargingStation’ to the response with the ‘200’ status

GET /systems

  • added the optional property ‘/items/gatewayStatus’ to the response with the ‘200’ status

POST /systems

  • added the optional property ‘gatewayStatus’ to the response with the ‘201’ status

GET /systems/{systemID}

  • added the optional property ‘gatewayStatus’ to the response with the ‘200’ status

PATCH /systems/{systemID}

  • added the optional property ‘gatewayStatus’ to the response with the ‘200’ status

GET /user/stars/systems

  • added the optional property ‘/items/gatewayStatus’ to the response with the ‘200’ status

(sha 871e8796)

29

Changelog 2025-06-20T10:22:40.481Z

GET /gateways/{gatewayID}/appliances

  • :warning: added the new ‘3.00’ enum value to the ‘/items/oneOf[subschema #6: Heater]/heater/medium’ response property for the response status ‘200’
  • :warning: added the new ‘4.00’ enum value to the ‘/items/oneOf[subschema #6: Heater]/heater/medium’ response property for the response status ‘200’
  • :warning: added the new ‘MY_PV_AC_ELWA_2’ enum value to the ‘/items/oneOf[subschema #6: Heater]/heater/type’ response property for the response status ‘200’
  • :warning: added the new ‘SIMULATION’ enum value to the ‘/items/oneOf[subschema #5: IO Device]/ioDevice/type’ response property for the response status ‘200’

GET /gateways/{gatewayID}/appliances/{applianceID}

  • :warning: added the new ‘3.00’ enum value to the ‘/oneOf[subschema #6: Heater]/heater/medium’ response property for the response status ‘200’
  • :warning: added the new ‘4.00’ enum value to the ‘/oneOf[subschema #6: Heater]/heater/medium’ response property for the response status ‘200’
  • :warning: added the new ‘MY_PV_AC_ELWA_2’ enum value to the ‘/oneOf[subschema #6: Heater]/heater/type’ response property for the response status ‘200’
  • :warning: added the new ‘SIMULATION’ enum value to the ‘/oneOf[subschema #5: IO Device]/ioDevice/type’ response property for the response status ‘200’

PATCH /gateways/{gatewayID}/appliances/{applianceID}

  • :warning: added the new ‘3.00’ enum value to the ‘/oneOf[subschema #6: Heater]/heater/medium’ response property for the response status ‘200’
  • :warning: added the new ‘4.00’ enum value to the ‘/oneOf[subschema #6: Heater]/heater/medium’ response property for the response status ‘200’
  • :warning: added the new ‘MY_PV_AC_ELWA_2’ enum value to the ‘/oneOf[subschema #6: Heater]/heater/type’ response property for the response status ‘200’
  • :warning: added the new ‘SIMULATION’ enum value to the ‘/oneOf[subschema #5: IO Device]/ioDevice/type’ response property for the response status ‘200’

GET /gateways/{gatewayID}/appliances/{applianceID}/measurements

  • removed ‘#/components/schemas/HeaterMeasurementRaw’ from the ‘/items/’ response property ‘oneOf’ list for the response status ‘200’

GET /gateways/{gatewayID}/appliances/{applianceID}/measurements/appliance

  • removed ‘#/components/schemas/HeaterMeasurementRaw’ from the ‘/items/’ response property ‘oneOf’ list for the response status ‘200’

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘3.00’ enum value to the ‘/items/appliances/items/oneOf[subschema #6: Heater]/heater/medium’ response property for the response status ‘200’
  • :warning: added the new ‘4.00’ enum value to the ‘/items/appliances/items/oneOf[subschema #6: Heater]/heater/medium’ response property for the response status ‘200’
  • :warning: added the new ‘MY_PV_AC_ELWA_2’ enum value to the ‘/items/appliances/items/oneOf[subschema #6: Heater]/heater/type’ response property for the response status ‘200’
  • :warning: added the new ‘SIMULATION’ enum value to the ‘/items/appliances/items/oneOf[subschema #5: IO Device]/ioDevice/type’ response property for the response status ‘200’

GET /user/stars/systems

  • :warning: removed the required property ‘/items/createdAt’ from the response with the ‘200’ status
  • :warning: removed the required property ‘/items/gateways/items/createdAt’ from the response with the ‘200’ status
  • :warning: removed the required property ‘/items/gateways/items/updatedAt’ from the response with the ‘200’ status
  • :warning: removed the required property ‘/items/updatedAt’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/accounts’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/appliancePriorities’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/chargingIntervals’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/curtailmentStrategy’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/gatewayStatus’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/gateways/items/additionalIdentifiers’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/gateways/items/applianceComposition’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/gateways/items/debugModeUntil’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/gateways/items/manufacturer’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/gateways/items/model’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/gateways/items/name’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/gateways/items/registeredAt’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/gateways/items/scanners’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/gateways/items/startcode’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/gateways/items/vendorID’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/location’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/metadata’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/operatingSince’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/plan’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/priorities’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/productOption’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/productOptionUpdatedAt’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/solution’ from the response with the ‘200’ status
  • :warning: removed the optional property ‘/items/status’ from the response with the ‘200’ status

(sha 80571c58)

30

Changelog 2025-07-01T09:41:20.344Z

GET /systems/{systemID}/tariff

  • added the optional property ‘gridFeeType’ to the response with the ‘200’ status

PATCH /systems/{systemID}/tariff

  • added the optional property ‘gridFeeType’ to the response with the ‘200’ status

POST /systems/{systemID}/tariff

  • added the optional property ‘gridFeeType’ to the response with the ‘201’ status

GET /systems/{systemID}/tariff/grid-fees

  • endpoint added

(sha 26543dec)

31

Changelog 2025-07-07T13:59:46.187Z

GET /gateways/{gatewayID}/appliances

  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/items/oneOf[subschema #2: Meter]/auxMeter/location’ response property for the response status ‘200’
  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/items/oneOf[subschema #2: Meter]/kind’ response property for the response status ‘200’

GET /gateways/{gatewayID}/appliances/{applianceID}

  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/oneOf[subschema #2: Meter]/auxMeter/location’ response property for the response status ‘200’
  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/oneOf[subschema #2: Meter]/kind’ response property for the response status ‘200’

PATCH /gateways/{gatewayID}/appliances/{applianceID}

  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/oneOf[subschema #2: Meter]/auxMeter/location’ response property for the response status ‘200’
  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/oneOf[subschema #2: Meter]/kind’ response property for the response status ‘200’

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/items/appliances/items/oneOf[subschema #2: Meter]/auxMeter/location’ response property for the response status ‘200’
  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/items/appliances/items/oneOf[subschema #2: Meter]/kind’ response property for the response status ‘200’

POST /systems/{systemID}/gateways

  • added the non-success response with the status ‘409’

(sha a46da76e)

32

Changelog 2025-07-08T10:19:24.817Z

GET /gateways/{gatewayID}/appliances

  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/items/oneOf[subschema #2: Meter]/auxMeter/location’ response property for the response status ‘200’
  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/items/oneOf[subschema #2: Meter]/kind’ response property for the response status ‘200’

GET /gateways/{gatewayID}/appliances/{applianceID}

  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/oneOf[subschema #2: Meter]/auxMeter/location’ response property for the response status ‘200’
  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/oneOf[subschema #2: Meter]/kind’ response property for the response status ‘200’

PATCH /gateways/{gatewayID}/appliances/{applianceID}

  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/oneOf[subschema #2: Meter]/auxMeter/location’ response property for the response status ‘200’
  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/oneOf[subschema #2: Meter]/kind’ response property for the response status ‘200’

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/items/appliances/items/oneOf[subschema #2: Meter]/auxMeter/location’ response property for the response status ‘200’
  • :warning: added the new ‘AIR_CONDITIONER’ enum value to the ‘/items/appliances/items/oneOf[subschema #2: Meter]/kind’ response property for the response status ‘200’

POST /systems/{systemID}/gateways

  • added the non-success response with the status ‘409’

(sha bc613bf0)

33

Changelog 2025-07-15T14:07:15.800Z

GET /clusters/{clusterID}/live

  • added the optional property ‘airConditioner’ to the response with the ‘200’ status

POST /emobility/assets

  • endpoint added

DELETE /systems/{systemID}/emobility/timeofuse

  • endpoint added

GET /systems/{systemID}/emobility/timeofuse

  • endpoint added

POST /systems/{systemID}/emobility/timeofuse

  • endpoint added

DELETE /systems/{systemID}/evcs-user-priorities

  • endpoint added

GET /systems/{systemID}/evcs-user-priorities

  • endpoint added

PUT /systems/{systemID}/evcs-user-priorities/{assetID}

  • endpoint added

GET /systems/{systemID}/historical

  • added the optional property ‘data/items/airConditioner’ to the response with the ‘200’ status
  • added the optional property ‘total/airConditioner’ to the response with the ‘200’ status

GET /systems/{systemID}/live

  • added the optional property ‘airConditioner’ to the response with the ‘200’ status

(sha 16517734)

34

Changelog 2025-07-23T13:45:50.856Z

GET /accounts/{accountID}/parents

  • added the required property ‘/items/kind’ to the response with the ‘200’ status

GET /accounts/{accountID}/systems

  • :warning: added the new ‘DAIKIN_ALTHERMA4_MODBUS_TCP_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

GET /gateways

  • :warning: added the new ‘DAIKIN_ALTHERMA4_MODBUS_TCP_HEAT_PUMP’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}

  • :warning: added the new ‘DAIKIN_ALTHERMA4_MODBUS_TCP_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘DAIKIN_ALTHERMA4_MODBUS_TCP_HEAT_PUMP’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /gateways/{gatewayID}

  • :warning: added the new ‘DAIKIN_ALTHERMA4_MODBUS_TCP_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘DAIKIN_ALTHERMA4_MODBUS_TCP_HEAT_PUMP’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’

GET /systems

  • :warning: added the new ‘DAIKIN_ALTHERMA4_MODBUS_TCP_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems

  • :warning: added the new ‘DAIKIN_ALTHERMA4_MODBUS_TCP_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}

  • :warning: added the new ‘DAIKIN_ALTHERMA4_MODBUS_TCP_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

PATCH /systems/{systemID}

  • :warning: added the new ‘DAIKIN_ALTHERMA4_MODBUS_TCP_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’

POST /systems/{systemID}/gateways

  • :warning: added the new ‘DAIKIN_ALTHERMA4_MODBUS_TCP_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}/timeofuse/status

  • :warning: added the new ‘INTERNAL_BATTERY_FLEXIBILITY_INVALID’ enum value to the ‘periods/items/error_code’ response property for the response status ‘200’
  • :warning: added the new ‘INTERNAL_GET_CONSTRAINTS_EVCS’ enum value to the ‘periods/items/error_code’ response property for the response status ‘200’
  • :warning: added the new ‘INTERNAL_GET_FLEXIBILITY_EVCS’ enum value to the ‘periods/items/error_code’ response property for the response status ‘200’

GET /systems/{systemID}/timeofuse/status/current

  • :warning: added the new ‘INTERNAL_BATTERY_FLEXIBILITY_INVALID’ enum value to the ‘status/error_code’ response property for the response status ‘200’
  • :warning: added the new ‘INTERNAL_GET_CONSTRAINTS_EVCS’ enum value to the ‘status/error_code’ response property for the response status ‘200’
  • :warning: added the new ‘INTERNAL_GET_FLEXIBILITY_EVCS’ enum value to the ‘status/error_code’ response property for the response status ‘200’

(sha 4551cdc9)

36

Changelog 2025-07-29T12:48:44.431Z

GET /accounts/{accountID}/users/{userID}/notifications/rules

  • :warning: removed the optional property ‘/items/filters’ from the response with the ‘200’ status

POST /accounts/{accountID}/users/{userID}/notifications/rules

  • :warning: removed the optional property ‘filters’ from the response with the ‘201’ status

GET /accounts/{accountID}/users/{userID}/notifications/rules/{ruleID}

  • :warning: removed the optional property ‘filters’ from the response with the ‘200’ status

GET /systems/{systemID}/ev-profiles

  • added the optional property ‘/items/zeroLockDuration’ to the response with the ‘200’ status

POST /systems/{systemID}/ev-profiles

  • added the optional property ‘zeroLockDuration’ to the response with the ‘201’ status

GET /systems/{systemID}/ev-profiles/{evProfileID}

  • added the optional property ‘zeroLockDuration’ to the response with the ‘200’ status

PATCH /systems/{systemID}/ev-profiles/{evProfileID}

  • added the new optional request property ‘zeroLockDuration’
  • added the optional property ‘zeroLockDuration’ to the response with the ‘200’ status

(sha 8d287f11)

37

Changelog 2025-08-05T15:23:59.350Z

GET /accounts/{accountID}/systems

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_CONFIGURATION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_HEAT_PUMP_CONFIGURATION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’

GET /gateways

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_CONFIGURATION’ enum value to the ‘system/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_HEAT_PUMP_CONFIGURATION’ enum value to the ‘system/metadata/wizard/step’ response property for the response status ‘200’

PATCH /gateways/{gatewayID}

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}/appliances

  • added the optional property ‘/items/oneOf[subschema #6: Heater]/model’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/appliances/{applianceID}

  • added the optional property ‘/oneOf[subschema #6: Heater]/model’ to the response with the ‘200’ status

PATCH /gateways/{gatewayID}/appliances/{applianceID}

  • added the optional property ‘/oneOf[subschema #6: Heater]/model’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • added the optional property ‘/items/appliances/items/oneOf[subschema #6: Heater]/model’ to the response with the ‘200’ status

GET /systems

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_CONFIGURATION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_HEAT_PUMP_CONFIGURATION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’

POST /systems

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘IO_DEVICE_CONFIGURATION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘201’
  • :warning: added the new ‘IO_DEVICE_HEAT_PUMP_CONFIGURATION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘201’

GET /systems/{systemID}

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_CONFIGURATION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_HEAT_PUMP_CONFIGURATION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’

PATCH /systems/{systemID}

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_CONFIGURATION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_HEAT_PUMP_CONFIGURATION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’

GET /systems/{systemID}/assets/{assetID}

  • endpoint added

PATCH /systems/{systemID}/emobility/timeofuse

  • endpoint added

GET /systems/{systemID}/ev-profiles

  • added the optional property ‘/items/zeroLockDuration’ to the response with the ‘200’ status

POST /systems/{systemID}/ev-profiles

  • added the optional property ‘zeroLockDuration’ to the response with the ‘201’ status

GET /systems/{systemID}/ev-profiles/{evProfileID}

  • added the optional property ‘zeroLockDuration’ to the response with the ‘200’ status

PATCH /systems/{systemID}/ev-profiles/{evProfileID}

  • added the new optional request property ‘zeroLockDuration’
  • added the optional property ‘zeroLockDuration’ to the response with the ‘200’ status

POST /systems/{systemID}/gateways

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}/tariff

  • the response optional property ‘gridFeeType’ became read-only for the status ‘200’

PATCH /systems/{systemID}/tariff

  • the response optional property ‘gridFeeType’ became read-only for the status ‘200’

POST /systems/{systemID}/tariff

  • the response optional property ‘gridFeeType’ became read-only for the status ‘201’

GET /systems/{systemID}/timeofuse/readiness

  • :warning: added the new ‘INFORMALLY_SUPPORTED_BATTERY_INVERTER’ enum value to the ‘reasons/items/’ response property for the response status ‘200’
  • :warning: added the new ‘INFORMALLY_SUPPORTED_EVCS’ enum value to the ‘reasons/items/’ response property for the response status ‘200’
  • :warning: added the new ‘INFORMALLY_SUPPORTED_HEAT_PUMP’ enum value to the ‘reasons/items/’ response property for the response status ‘200’
  • :warning: added the new ‘INFORMALLY_SUPPORTED_PV_INVERTER’ enum value to the ‘reasons/items/’ response property for the response status ‘200’

(sha 29c08396)

38

Changelog 2025-08-07T12:15:18.411Z

GET /accounts/{accountID}/systems

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_CONFIGURATION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_HEAT_PUMP_CONFIGURATION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’

POST /emobility/assets

  • api tag ‘draft’ added
  • api tag ‘alpha’ removed

GET /gateways

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘/items/scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘system/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_CONFIGURATION’ enum value to the ‘system/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_HEAT_PUMP_CONFIGURATION’ enum value to the ‘system/metadata/wizard/step’ response property for the response status ‘200’

PATCH /gateways/{gatewayID}

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘scanners/items/’ response property for the response status ‘200’

GET /gateways/{gatewayID}/appliances

  • added the optional property ‘/items/oneOf[subschema #6: Heater]/model’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/appliances/{applianceID}

  • added the optional property ‘/oneOf[subschema #6: Heater]/model’ to the response with the ‘200’ status

PATCH /gateways/{gatewayID}/appliances/{applianceID}

  • added the optional property ‘/oneOf[subschema #6: Heater]/model’ to the response with the ‘200’ status

GET /gateways/{gatewayID}/scans

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘/items/scanners/items/name’ response property for the response status ‘200’
  • added the optional property ‘/items/appliances/items/oneOf[subschema #6: Heater]/model’ to the response with the ‘200’ status

GET /systems

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘/items/gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_CONFIGURATION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_HEAT_PUMP_CONFIGURATION’ enum value to the ‘/items/metadata/wizard/step’ response property for the response status ‘200’

POST /systems

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘IO_DEVICE_CONFIGURATION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘201’
  • :warning: added the new ‘IO_DEVICE_HEAT_PUMP_CONFIGURATION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘201’

GET /systems/{systemID}

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_CONFIGURATION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_HEAT_PUMP_CONFIGURATION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’

PATCH /systems/{systemID}

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘gateways/items/scanners/items/’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_CONFIGURATION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’
  • :warning: added the new ‘IO_DEVICE_HEAT_PUMP_CONFIGURATION’ enum value to the ‘metadata/wizard/step’ response property for the response status ‘200’

GET /systems/{systemID}/assets/{assetID}

  • endpoint added

PATCH /systems/{systemID}/emobility/timeofuse

  • endpoint added

POST /systems/{systemID}/gateways

  • :warning: added the new ‘BOSCH_BUDERUS_EEBUS_HEAT_PUMP’ enum value to the ‘scanners/items/’ response property for the response status ‘201’
  • :warning: added the new ‘FOXESS_CHARGING_STATION’ enum value to the ‘scanners/items/’ response property for the response status ‘201’

GET /systems/{systemID}/tariff

  • the response optional property ‘gridFeeType’ became read-only for the status ‘200’

PATCH /systems/{systemID}/tariff

  • the response optional property ‘gridFeeType’ became read-only for the status ‘200’

POST /systems/{systemID}/tariff

  • the response optional property ‘gridFeeType’ became read-only for the status ‘201’

GET /systems/{systemID}/timeofuse/decisions

  • :warning: added the new ‘BATTERY_PREVENT_CHARGE_TO_EXPORT_SURPLUS_AT_HIGH_EXPORT_PRICE’ enum value to the ‘decisions/items/insight/motives/items/’ response property for the response status ‘200’

GET /systems/{systemID}/timeofuse/readiness

  • :warning: added the new ‘INFORMALLY_SUPPORTED_BATTERY_INVERTER’ enum value to the ‘reasons/items/’ response property for the response status ‘200’
  • :warning: added the new ‘INFORMALLY_SUPPORTED_EVCS’ enum value to the ‘reasons/items/’ response property for the response status ‘200’
  • :warning: added the new ‘INFORMALLY_SUPPORTED_HEAT_PUMP’ enum value to the ‘reasons/items/’ response property for the response status ‘200’
  • :warning: added the new ‘INFORMALLY_SUPPORTED_PV_INVERTER’ enum value to the ‘reasons/items/’ response property for the response status ‘200’

(sha ccfb1ac5)

39

Changelog 2025-08-07T13:46:32.029Z

POST /emobility/assets

  • api tag ‘draft’ added
  • api tag ‘alpha’ removed

GET /systems/{systemID}/timeofuse/decisions

  • :warning: added the new ‘BATTERY_PREVENT_CHARGE_TO_EXPORT_SURPLUS_AT_HIGH_EXPORT_PRICE’ enum value to the ‘decisions/items/insight/motives/items/’ response property for the response status ‘200’

(sha 3d8e7bc3)

40

Changelog 2025-08-12T14:31:43.220Z

DELETE /accounts/{accountID}/systems

  • the ‘moveSystemsAndCustomers’ request property default value ‘true’ was added
  • the ‘moveVendorID’ request property default value ‘true’ was added

GET /accounts/{accountID}/systems

  • added the optional property ‘/items/metadata/wizard/firstCompletedAt’ to the response with the ‘200’ status
  • added the optional property ‘/items/metadata/wizard/version’ to the response with the ‘200’ status

GET /gateways/{gatewayID}

  • added the optional property ‘system/metadata/wizard/firstCompletedAt’ to the response with the ‘200’ status
  • added the optional property ‘system/metadata/wizard/version’ to the response with the ‘200’ status

GET /systems

  • added the optional property ‘/items/metadata/wizard/firstCompletedAt’ to the response with the ‘200’ status
  • added the optional property ‘/items/metadata/wizard/version’ to the response with the ‘200’ status

POST /systems

  • added the optional property ‘metadata/wizard/firstCompletedAt’ to the response with the ‘201’ status
  • added the optional property ‘metadata/wizard/version’ to the response with the ‘201’ status

GET /systems/{systemID}

  • added the optional property ‘metadata/wizard/firstCompletedAt’ to the response with the ‘200’ status
  • added the optional property ‘metadata/wizard/version’ to the response with the ‘200’ status

PATCH /systems/{systemID}

  • added the optional property ‘metadata/wizard/firstCompletedAt’ to the response with the ‘200’ status
  • added the optional property ‘metadata/wizard/version’ to the response with the ‘200’ status

(sha ff3e3a59)

41

Changelog 2025-08-13T11:56:16.300Z

DELETE /accounts/{accountID}/systems

  • the ‘moveSystemsAndCustomers’ request property default value ‘true’ was added
  • the ‘moveVendorID’ request property default value ‘true’ was added

GET /accounts/{accountID}/systems

  • added the optional property ‘/items/metadata/wizard/firstCompletedAt’ to the response with the ‘200’ status
  • added the optional property ‘/items/metadata/wizard/version’ to the response with the ‘200’ status

GET /gateways/{gatewayID}

  • added the optional property ‘system/metadata/wizard/firstCompletedAt’ to the response with the ‘200’ status
  • added the optional property ‘system/metadata/wizard/version’ to the response with the ‘200’ status

GET /systems

  • added the optional property ‘/items/metadata/wizard/firstCompletedAt’ to the response with the ‘200’ status
  • added the optional property ‘/items/metadata/wizard/version’ to the response with the ‘200’ status

POST /systems

  • added the optional property ‘metadata/wizard/firstCompletedAt’ to the response with the ‘201’ status
  • added the optional property ‘metadata/wizard/version’ to the response with the ‘201’ status

GET /systems/{systemID}

  • added the optional property ‘metadata/wizard/firstCompletedAt’ to the response with the ‘200’ status
  • added the optional property ‘metadata/wizard/version’ to the response with the ‘200’ status

PATCH /systems/{systemID}

  • added the optional property ‘metadata/wizard/firstCompletedAt’ to the response with the ‘200’ status
  • added the optional property ‘metadata/wizard/version’ to the response with the ‘200’ status

(sha e9bcdffa)

42

Changelog 2025-08-14T12:05:31.304Z

DELETE /accounts/{accountID}/systems

  • the ‘moveSystemsAndCustomers’ request property default value ‘true’ was removed
  • the ‘moveVendorID’ request property default value ‘true’ was removed

(sha 83df0f5a)

43

Changelog 2025-08-14T14:23:43.356Z

GET /accounts/{accountID}/webhooks

  • endpoint added

POST /accounts/{accountID}/webhooks

  • endpoint added

DELETE /accounts/{accountID}/webhooks/{webhookID}

  • endpoint added

GET /accounts/{accountID}/webhooks/{webhookID}

  • endpoint added

PUT /accounts/{accountID}/webhooks/{webhookID}

  • endpoint added

POST /accounts/{accountID}/webhooks/{webhookID}/ping

  • endpoint added

POST /accounts/{accountID}/webhooks/{webhookID}/secret

  • endpoint added

(sha e782a73d)