curl --request PATCH \
  --url https://api.nox.energy/v1/devices/pv/settings \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "user456",
  "device_id": "device123",
  "optimization_settings": {
    "pv_curtailment_mode": "managed"
  },
  "location": {
    "country": "NL",
    "postal_code": "1234AB"
  }
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

User Management

Patch Devices Pv Settings

Update on a device or user level the device/user settings. If you want to update a setting on a device level, provide the device_id instead. Any of the settings can be updated separately or together.

You can change the following settings:

Enable/Disable steering optimizations. pv_curtailment_mode can be set to managed, external or off. If managed is enabled, we will optimize the pv curtailment. If external is enabled, we steer based on schedules provided by external parties like energy suppliers. If off is enabled, we will not curtail the pv.
The country code and the postal code

PATCH

devices

settings

curl --request PATCH \
  --url https://api.nox.energy/v1/devices/pv/settings \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "user456",
  "device_id": "device123",
  "optimization_settings": {
    "pv_curtailment_mode": "managed"
  },
  "location": {
    "country": "NL",
    "postal_code": "1234AB"
  }
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

x-api-key

string

header

required

API Key authentication. Enter your API key in the format: YOUR_API_KEY

Body

application/json

device_id

string | null

Device ID to update settings for

user_id

string | null

User ID to update settings for

optimization_settings

OptimizationSettings · object | null

Optimization settings for the device

Show child attributes

location

LocationSettings · object | null

Location-related settings

Show child attributes

Response

No Content - Settings updated successfully

Get Devices Pv Control Flex Logs

API setup

Full NOX Control Package

Supplier Control Package

Manufacturer Package

Connecting Users and Devices

PV

Patch Devices Pv Settings

Authorizations

Body

Response