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
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

Body Params application/json

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 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 --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

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