1. VPP
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. VPP

client mode onboard

POST
/op/v0/vpp/oauth2/client/onboard

Request

Authorization
or
or
Header Params

Body Params application/json

Example
{
    "deviceSN": "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/vpp/oauth2/client/onboard' \
--header 'Content-Type: application/json' \
--data '{
    "deviceSN": "string"
}'

Responses

🟢200成功
application/json
Bodyapplication/json

Example
{
    "errno": 0,
    "msg": "string"
}
Modified at 2026-08-19 09:17:05
Previous
client mode offboard
Next
Get device setting capabilities
Built with