POST
/
v1
/
flex
/
down
Execute Flex Up Across Devices
curl --request POST \
  --url https://api.sandbox.nox.energy/v1/flex/down \
  --header 'x-api-key: <api-key>'
{
  "message": "Flex down operation successful across all devices for 500.0 kWh.",
  "meta": {
    "energy_supplier": "Energy Supplier A"
  }
}

Authorizations

x-api-key
string
header
required

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

Query Parameters

energy
number
default:0

The amount of energy you want to use for flex in kWh.

Response

200
application/json

Successful response

The response is of type object.