Flip Energy API
  1. Devices
Flip Energy API
  • Overview
  • Important concepts
  • Authentication
  • Enrollment process
  • End-user app design
  • Monitoring / Telemetry
  • Control
  • Change log
  • Mobile App API
    • Devices
      • Create Device
        POST
      • Read Devices
        GET
      • Read Device
        GET
      • Update Device
        PATCH
      • Delete Device
        DELETE
    • Enrollments
      • Create Enrollment
      • Read Enrollments
      • Read Enrollment
      • Delete Enrollment
    • Events
      • Read Events
      • Read Event
      • Update Event Participation
    • Programs
      • Read Programs
      • Read Program
    • Sites
      • Read Site
      • Update Site
  • Cloud API
    • Sites
      • Get Site Token
      • Get Sites
    • Commissioning
      • Commission Site And Devices
    • Sessions
      • Sessions
    • Commands
      • Command Created
      • Update Command Status
    • Programs
      • Read Programs
    • Telemetry
      • Report Battery Telemetry
    • Webhooks
      • Overview
      • List of events
      • Webhook headers
      • Schemas
        • Command
        • Enrollment
        • Event
  1. Devices

Create Device

Cloud Mock
https://mock.apidog.com/m1/479670-0-default
Cloud Mock
https://mock.apidog.com/m1/479670-0-default
POST
/v1/site/{siteId}/devices
devices
Note that you need the client authentication token (not the site token) to access the API.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
siteId
string 
required
Body Params application/json
id
string 
Id
required
Example:
xyz-123
site_id
string 
required
Example:
abc-789
manufacturer_name
string 
Manufacturer Name
required
Example:
DeviceMaker
product_name
string 
Product Name
required
Example:
Model 1
serial_number
string 
Serial Number
required
Example:
123456789
type
enum<string> 
required
Allowed values:
BATTERYEV_CHARGER
attributes
object (DeviceBatteryAttributes) 
required
Structure depends on type. They are not user-adjustable and should be configured during installation / commissioning.
battery_capacity_wh
integer 
required
Nominal power capacity of the battery per manufacturer specification, in watt-hours
Example:
15000
battery_power_input_w
integer 
required
The rated power the battery can continuously discharge at per manufacturer specification, in watts.
Example:
6000
battery_power_output_w
integer 
required
The rated power the battery can continuously charge at per manufacturer specification, in watts.
Example:
7500
configuration
object (DeviceBatteryConfig) 
deprecated
Deprecated. Values will be accepted but ignored.
reserve_percentage
integer 
deprecated
User-configurable level that the battery should reserve as a minimum for all VPP events.
Example:
20
install_date
string <date-time>
required
The date the device was installed at the customer's site, or the date it received permission to operate from the utility, if different.
Example:
2025-06-19T15:30:00-07:00
Example
{
    "id": "xyz-123",
    "site_id": "abc-789",
    "manufacturer_name": "DeviceMaker",
    "product_name": "Model 1",
    "serial_number": "123456789",
    "type": "BATTERY",
    "attributes": {
        "battery_capacity_wh": 15000,
        "battery_power_input_w": 6000,
        "battery_power_output_w": 7500
    },
    "configuration": {
        "reserve_percentage": 20
    },
    "install_date": "2025-06-19T15:30:00-07:00"
}

Request 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 --request POST 'https://mock.apidog.com/m1/479670-0-default/v1/site//devices' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "xyz-123",
    "site_id": "abc-789",
    "manufacturer_name": "DeviceMaker",
    "product_name": "Model 1",
    "serial_number": "123456789",
    "type": "BATTERY",
    "attributes": {
        "battery_capacity_wh": 15000,
        "battery_power_input_w": 6000,
        "battery_power_output_w": 7500
    },
    "configuration": {
        "reserve_percentage": 20
    },
    "install_date": "2025-06-19T15:30:00-07:00"
}'

Responses

🟢200OK
application/json
Body
id
string 
Id
required
Example:
xyz-123
site_id
string 
required
Example:
abc-789
manufacturer_name
string 
Manufacturer Name
required
Example:
DeviceMaker
product_name
string 
Product Name
required
Example:
Model 1
serial_number
string 
Serial Number
required
Example:
123456789
type
enum<string> 
required
Allowed values:
BATTERYEV_CHARGER
attributes
object (DeviceBatteryAttributes) 
required
Structure depends on type. They are not user-adjustable and should be configured during installation / commissioning.
battery_capacity_wh
integer 
required
Nominal power capacity of the battery per manufacturer specification, in watt-hours
Example:
15000
battery_power_input_w
integer 
required
The rated power the battery can continuously discharge at per manufacturer specification, in watts.
Example:
6000
battery_power_output_w
integer 
required
The rated power the battery can continuously charge at per manufacturer specification, in watts.
Example:
7500
configuration
object (DeviceBatteryConfig) 
required
Structure depends on type
reserve_percentage
integer 
required
User-configurable level that the battery should reserve as a minimum for all VPP events.
Example:
20
install_date
string <date-time>
required
The date the device was installed at the customer's site, or the date it received permission to operate from the utility, if different.
Example:
2022-02-22
created_at
string <date-time>
Created At
read-onlyrequired
updated_at
string <date-time>
Updated At
read-onlyrequired
Example
{
    "id": "xyz-123",
    "site_id": "abc-789",
    "manufacturer_name": "DeviceMaker",
    "product_name": "Model 1",
    "serial_number": "123456789",
    "type": "BATTERY",
    "attributes": {
        "battery_capacity_wh": 15000,
        "battery_power_input_w": 6000,
        "battery_power_output_w": 7500
    },
    "configuration": {
        "reserve_percentage": 20
    },
    "install_date": "2022-02-22",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
}
🟠400Invalid input
🟠409Conflict
Modified at 2025-04-28 13:58:29
Previous
Change log
Next
Read Devices
Built with