1. Power Station
FoxCloud OpenAPI
Full API Reference
  • Vpp Flow
  • Full API Reference
  • Power Station
    • Get power station list
      POST
    • Get power station detail
      GET
    • Create power station
      POST
    • Delete power station
      POST
    • Edit power station
      POST
  • VPP
    • authorization code mode offboard by sn
      POST
    • client mode offboard
      POST
    • client mode onboard
      POST
  • Inverter-V1
    • Get device setting capabilities
      POST
    • Read device settings
      POST
    • Write device settings
      POST
    • Get device detail
      GET
    • Get device real-time data
      POST
  • Inverter
    • Get device list
      POST
    • Get device detail (Deprecated)
      GET
    • Get available variables
      GET
    • Get error code information
      GET
    • Get device real-time data (Deprecated)
      POST
    • Get device history data
      POST
    • Get device production report
      POST
    • Get device power generation
      GET
    • Get the minimum soc settings for the battery of device
      GET
    • Set the minmum soc for the battery of the device
      POST
    • Get the setting of battery charging time
      GET
    • Set the battery charging time
      POST
    • Get the device settings item
      POST
    • Set the device settings item
      POST
    • Get the device time
      POST
    • Set the device time
      POST
    • Get the device peakshaving settings
      POST
    • Set the device peakshaving settings
      POST
    • Get the Meter Reader
      POST
    • Set the Meter Reader
      POST
    • Get battery heating Parameter
      POST
    • Set battery heating Parameter
      POST
    • Get display sleep Paeameter
      POST
    • Set display sleep Paeameter
      POST
    • Get the device third party PV Integration status
      GET
    • Get Device Fault History
      POST
    • Get device PV power generation
      GET
  • Scheduler-V3
    • Get the time segment information
    • Set the time segment information
    • Batch set the time segment information
  • Scheduler-V2
    • Get the time segment information
    • Set the time segment information
  • Scheduler-V1
    • Get the main switch status
    • Set the main switch status
    • Get the time segment information
    • Set the time segment information
  • Scheduler (Deprecated)
    • Get the main switch status (Deprecated)
    • Get the time segment information (Deprecated)
    • Set the main switch status (Deprecated)
    • Set the time segment information (Deprecated)
  • Data Logger
    • Get Data Logger list
    • Get Data Logger Details
    • Get Data Logger Signal
    • Get Data Logger Wifi Info
    • Get Data Logger Lan Info
  • EMS
    • Get Ems list
    • Get Ems real-time data
    • Get Ems history data
    • Get Ems System Setting
    • Set Ems System Setting
    • Get Ems Rate Setting
    • Set Ems Rate Setting
    • Set Ems Ac Output Control Setting
    • Get Ems Ac Output Control Setting
    • Set Ems Power Limit Control Setting
    • Get Ems Power Limit Control Setting
    • Set Ems More Setting
    • Get Ems More Setting
    • Set Ems Gen Setting
    • Get Ems Gen Setting
  • Meter
    • Get meter list
    • Get the device settings item
    • Set the device settings item
  • Heat
    • genericControlsGet
    • genericControlsSet
    • heatingControlsGet
    • heatingControlsSet
    • heatingCircuitsControlsGet
    • heatingCircuitsControlsSet
    • dhwControlsGet
    • dhwControlsSet
    • heatAssetList-OAuth flow unsupported
    • changeKafkaPushStatus-OAuth flow unsupported
  • Schemas
    • CapabilityRequest
    • batteryList
    • HeatAssetListParam
    • CapabilityResponse
    • Result
    • CapabilityResult
    • CapabilityGroup
    • WeComLoginRequest
    • CapabilityField
    • ResponseInfo
    • ValueRange
    • Holiday
    • SettingGetRequest
    • DailyTimer
    • SettingGetResponse
    • GenericControlsData
    • SettingGetResult
    • GenericControlsParam
    • SettingSetRequest
    • WeekTimerItem
    • SettingSetResponse
    • HeatingControlsData
    • HeatingControlsParam
    • CircuitActivation
    • CircuitType
    • HeatingCircuitsControlsParam
    • DhwControlsData
    • DhwControlsParam
    • HolidayAway
    • HolidayHome
    • HeatKafkaPushStatusParam
    • TimerItem
    • DailyTimerTimerItem
    • DhwTimerItem
    • DailyTimerDhwTimerItem
    • TimerItem
    • DailyTimer
    • WeeklyTimer
    • DailyTimerTimerItem
    • BivalencePoint
    • DhwTimerItem
    • AuxiliaryHeaterSettings
    • DailyTimerDhwTimerItem
    • WeeklyTimerWeekTimerItem
    • BaseWeekTimerItem
    • WeeklyTimerBaseWeekTimerItem
    • CureSetting
    • HeatingCurves
    • HeatingCircuitsControlsData
    • TimerItem
    • DailyTimer
    • BivalencePoint
    • AuxiliaryHeaterSettings
  1. Power Station

Edit power station

POST
/op/v0/plant/update
request body example:
{
  "devices": [
    {
      "sn": "*******"
    }
  ],
  "pileSN": "*************",
  "details": {
    "stationID": "********************",
    "name": "name_51b2289bf18f",
    "type": 1,
    "countryCode": "CN",
    "city": "city_54049a6aad08",
    "address": "address_efdf02e2819d",
    "postcode": "213414",
    "price": 0.52,
    "currency": "CNY(¥)",
    "systemCapacity": 72.00
  },
  "timezone": "Asia/Shanghai",
  "position": {
    "x": "x_9e0c3cf37a91",
    "y": "y_6fa583b5fe21",
    "format": "format_b9434db57b54",
    "pid": "pid_169c8579050c"
  },
  "electricmeterSN": "*********************",
  "layoutByMini": {
    "direction": 1,
    "arrange": [
      {
        "sn": "***********",
        "horizontal": 2,
        "vertical": 3,
        "azimuth": 30,
        "dipAngle": 45,
        "direction": 1,
        "capacity": 30,
        "model": "model_71300e86ba58"
      }
    ]
  }
}

Request

Authorization
Header Params

Body Params application/json

Example
{
    "devices": [
        {
            "sn": "string",
            "key": "string"
        }
    ],
    "pileSN": "string",
    "details": {
        "name": "string",
        "type": 0,
        "countryCode": "string",
        "city": "string",
        "address": "string",
        "postcode": "string",
        "price": 0,
        "currency": "string",
        "stationID": "string",
        "systemCapacity": 0
    },
    "timezone": "string",
    "position": {
        "format": "string",
        "x": "string",
        "y": "string",
        "pid": "string"
    },
    "electricmeterSN": "string",
    "layoutByMini": {
        "direction": 0,
        "arrange": [
            {
                "sn": "string",
                "horizontal": 0,
                "vertical": 0,
                "azimuth": 0,
                "dipAngle": 0,
                "direction": 0,
                "capacity": 0,
                "model": "string"
            }
        ]
    }
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/op/v0/plant/update' \
--header 'token;' \
--header 'signature;' \
--header 'timestamp;' \
--header 'lang: en' \
--header 'Content-Type: application/json' \
--data '{
    "devices": [
        {
            "sn": "string",
            "key": "string"
        }
    ],
    "pileSN": "string",
    "details": {
        "name": "string",
        "type": 0,
        "countryCode": "string",
        "city": "string",
        "address": "string",
        "postcode": "string",
        "price": 0,
        "currency": "string",
        "stationID": "string",
        "systemCapacity": 0
    },
    "timezone": "string",
    "position": {
        "format": "string",
        "x": "string",
        "y": "string",
        "pid": "string"
    },
    "electricmeterSN": "string",
    "layoutByMini": {
        "direction": 0,
        "arrange": [
            {
                "sn": "string",
                "horizontal": 0,
                "vertical": 0,
                "azimuth": 0,
                "dipAngle": 0,
                "direction": 0,
                "capacity": 0,
                "model": "string"
            }
        ]
    }
}'

Responses

🟢200成功
application/json
Bodyapplication/json

Example
{
    "errno": 0,
    "result": {
        "stationID": "string",
        "devices": [
            {
                "device": {
                    "sn": "string",
                    "key": "string"
                },
                "errno": 0
            }
        ]
    }
}
Modified at 2026-08-05 03:23:44
Previous
Delete power station
Next
authorization code mode offboard by sn
Built with