Cancel commands
curl --request POST \
--url https://api.kapa.energy/bat/v1/{id}/cancel_command \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"start": "2026-11-12T18:00:00Z",
"end": "2026-11-12T20:00:00Z"
}
'import requests
url = "https://api.kapa.energy/bat/v1/{id}/cancel_command"
payload = {
"start": "2026-11-12T18:00:00Z",
"end": "2026-11-12T20:00:00Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({start: '2026-11-12T18:00:00Z', end: '2026-11-12T20:00:00Z'})
};
fetch('https://api.kapa.energy/bat/v1/{id}/cancel_command', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kapa.energy/bat/v1/{id}/cancel_command",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'start' => '2026-11-12T18:00:00Z',
'end' => '2026-11-12T20:00:00Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kapa.energy/bat/v1/{id}/cancel_command"
payload := strings.NewReader("{\n \"start\": \"2026-11-12T18:00:00Z\",\n \"end\": \"2026-11-12T20:00:00Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kapa.energy/bat/v1/{id}/cancel_command")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"start\": \"2026-11-12T18:00:00Z\",\n \"end\": \"2026-11-12T20:00:00Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kapa.energy/bat/v1/{id}/cancel_command")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start\": \"2026-11-12T18:00:00Z\",\n \"end\": \"2026-11-12T20:00:00Z\"\n}"
response = http.request(request)
puts response.read_body{
"cancelled": [
{
"command_id": "cmd_610",
"battery_id": "bat_1",
"action": "discharge",
"parameters": {
"min_wh": 1500,
"max_wh": null
},
"start": "2026-11-12T18:00:00Z",
"end": "2026-11-12T19:00:00Z",
"status": "cancelled",
"status_reason": null,
"batch_id": null,
"created_at": "2026-11-12T16:02:51Z",
"updated_at": "2026-11-12T16:30:18Z"
}
]
}{
"type": "https://api.kapa.energy/problems/invalid-time-window",
"title": "Invalid time window",
"status": 400,
"code": "invalid_time_window",
"detail": "end must be after start.",
"invalid_params": [
{
"name": "end",
"reason": "must be after start"
}
]
}{
"type": "https://api.kapa.energy/problems/unauthorized",
"title": "Unauthorized",
"status": 401,
"code": "unauthorized",
"detail": "The access token has expired."
}{
"type": "https://api.kapa.energy/problems/battery-not-found",
"title": "Battery not found",
"status": 404,
"code": "battery_not_found",
"detail": "No battery with id bat_9 is accessible to this client."
}Commands
Cancel commands
Cancels every unfinished command on this battery (pending, scheduled or
active) whose window overlaps [start, end). With an empty body, all current
and upcoming commands are cancelled.
Active commands stop as soon as the manufacturer applies the cancellation. The battery then returns to its default behaviour, unless another command applies.
POST
/
bat
/
v1
/
{id}
/
cancel_command
Cancel commands
curl --request POST \
--url https://api.kapa.energy/bat/v1/{id}/cancel_command \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"start": "2026-11-12T18:00:00Z",
"end": "2026-11-12T20:00:00Z"
}
'import requests
url = "https://api.kapa.energy/bat/v1/{id}/cancel_command"
payload = {
"start": "2026-11-12T18:00:00Z",
"end": "2026-11-12T20:00:00Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({start: '2026-11-12T18:00:00Z', end: '2026-11-12T20:00:00Z'})
};
fetch('https://api.kapa.energy/bat/v1/{id}/cancel_command', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kapa.energy/bat/v1/{id}/cancel_command",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'start' => '2026-11-12T18:00:00Z',
'end' => '2026-11-12T20:00:00Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kapa.energy/bat/v1/{id}/cancel_command"
payload := strings.NewReader("{\n \"start\": \"2026-11-12T18:00:00Z\",\n \"end\": \"2026-11-12T20:00:00Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kapa.energy/bat/v1/{id}/cancel_command")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"start\": \"2026-11-12T18:00:00Z\",\n \"end\": \"2026-11-12T20:00:00Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kapa.energy/bat/v1/{id}/cancel_command")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start\": \"2026-11-12T18:00:00Z\",\n \"end\": \"2026-11-12T20:00:00Z\"\n}"
response = http.request(request)
puts response.read_body{
"cancelled": [
{
"command_id": "cmd_610",
"battery_id": "bat_1",
"action": "discharge",
"parameters": {
"min_wh": 1500,
"max_wh": null
},
"start": "2026-11-12T18:00:00Z",
"end": "2026-11-12T19:00:00Z",
"status": "cancelled",
"status_reason": null,
"batch_id": null,
"created_at": "2026-11-12T16:02:51Z",
"updated_at": "2026-11-12T16:30:18Z"
}
]
}{
"type": "https://api.kapa.energy/problems/invalid-time-window",
"title": "Invalid time window",
"status": 400,
"code": "invalid_time_window",
"detail": "end must be after start.",
"invalid_params": [
{
"name": "end",
"reason": "must be after start"
}
]
}{
"type": "https://api.kapa.energy/problems/unauthorized",
"title": "Unauthorized",
"status": 401,
"code": "unauthorized",
"detail": "The access token has expired."
}{
"type": "https://api.kapa.energy/problems/battery-not-found",
"title": "Battery not found",
"status": 404,
"code": "battery_not_found",
"detail": "No battery with id bat_9 is accessible to this client."
}Authorizations
OAuth 2.0 client credentials. Obtain a token from POST /token.
Path Parameters
Battery identifier.
Body
application/json
Lower bound of the window (inclusive). Omitted or null means no lower bound.
Pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?Z$Upper bound of the window (exclusive). Omitted or null means no upper bound.
Pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?Z$Response
Cancellation accepted. Lists the commands that were cancelled; empty if none matched.
Commands that were cancelled. Empty if none matched.
Show child attributes
Show child attributes