-
Notifications
You must be signed in to change notification settings - Fork 154
/
Copy pathrest-api.yaml
1452 lines (1450 loc) · 41.4 KB
/
rest-api.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: evcc REST-API
description: ""
version: latest
servers:
- url: https://demo.evcc.io/api
- url: "{SCHEME}://{IP}:{PORT}/api"
variables:
SCHEME:
default: http
enum:
- https
- http
IP:
default: 192.168.XXX.XXX
PORT:
default: "7070"
tags:
- name: General
- name: Loadpoints
- name: Vehicles
- name: Home Battery
- name: Tariffs
- name: Sessions
- name: Auth
- name: System
paths:
/auth/login:
post:
summary: Login
description: |
Login returns an auth cookie required for all protected endpoints.
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
password:
$ref: "#/components/schemas/Password"
responses:
"200":
description: Success
headers:
Set-Cookie:
description: The authorization cookie
schema:
type: string
example: >-
auth=ey...qY; Path=/; Expires=Fri, 04 Apr 2025 14:35:37 GMT;
HttpOnly; SameSite=Strict
"401":
description: Invalid password provided
/auth/logout:
post:
summary: Logout
description: Deletes the authorization cookie
tags:
- Auth
responses:
"200":
description: Success
headers:
Set-Cookie:
description: The authorization cookie
schema:
type: string
enum:
- auth=; Path=/; HttpOnly
/auth/password:
put:
summary: Change admin password
description: |
Changes the admin password.
tags:
- Auth
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ChangePassword"
responses:
"202":
description: Success
"400":
description: Invalid password provided
/auth/status:
get:
summary: Authentication status
description: Whether the current user is logged in.
tags:
- Auth
responses:
"200":
description: Success
content:
text/plain:
schema:
type: string
enum:
- "true"
- "false"
/batterydischargecontrol/{enable}:
post:
summary: Control battery-discharge
description: >
Prevent home battery discharge during vehicle fast charging. [Read
more.](/en/docs/features/battery)
tags:
- Home Battery
parameters:
- $ref: "#/components/parameters/enable"
responses:
"200":
$ref: "#/components/responses/BooleanResult"
/batterygridchargelimit:
delete:
summary: Remove battery grid charge limit
description: >
Remove battery grid charge limit. [Read
more.](/en/docs/features/battery)
tags:
- Home Battery
responses:
"200":
$ref: "#/components/responses/NullResult"
/batterygridchargelimit/{cost}:
post:
summary: Set battery grid charge limit
description: >
Charge home battery from grid when price or emissions are below the
threshold.
Uses price if a dynamic tariff exists. Uses emissions if a CO₂-tariff is
configured. Ignored otherwise.
[Read more.](/en/docs/features/battery)
tags:
- Home Battery
parameters:
- $ref: "#/components/parameters/costLimit"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/buffersoc/{soc}:
post:
summary: Set battery buffer SoC
description: |
Set battery buffer SoC. [Read more.](/en/docs/features/battery)
tags:
- Home Battery
parameters:
- $ref: "#/components/parameters/soc"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/bufferstartsoc/{soc}:
post:
summary: Set battery buffer start SoC
description: |
Set battery buffer start SoC. [Read more.](/en/docs/features/battery)
tags:
- Home Battery
parameters:
- $ref: "#/components/parameters/soc"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/health:
get:
summary: Health check
description: Returns 200 if the evcc loop runs as expected.
tags:
- General
responses:
"200":
description: Success
content:
text/plain:
schema:
type: string
example: OK
/loadpoints/{id}/batteryboost/{enable}:
post:
summary: Set battery boost
description: >
Enables or disables battery boost. [Read
more.](/en/docs/features/battery#battery-boost)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/enable"
responses:
"200":
$ref: "#/components/responses/BooleanResult"
/loadpoints/{id}/disable/delay/{delay}:
post:
summary: Disable threshold-delay
description: >
Specifies the delay before charging stops in solar mode. [Read
more.](/en/docs/reference/configuration/loadpoints)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/delay"
responses:
"200":
$ref: "#/components/responses/NanoSecondsResult"
/loadpoints/{id}/disable/threshold/{threshold}:
post:
summary: Disable threshold
description: >
Specifies the grid draw power to stop charging in solar mode. [Read
more.](/en/docs/reference/configuration/loadpoints#threshold-1)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/threshold"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/loadpoints/{id}/enable/delay/{delay}:
post:
summary: Enable threshold-delay
description: >
Specifies the delay before charging starts in solar mode. [Read
more.](/en/docs/reference/configuration/loadpoints#delay)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/delay"
responses:
"200":
$ref: "#/components/responses/NanoSecondsResult"
/loadpoints/{id}/enable/threshold/{threshold}:
post:
summary: Enable threshold
description: >
Specifies the available surplus power to start charging in solar mode.
[Read more.](/en/docs/reference/configuration/loadpoints#threshold)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/threshold"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/loadpoints/{id}/limitenergy/{power}:
post:
summary: Update energy limit
description: >
Updates the energy limit of the loadpoint. Only available for guest
vehicles and vehicles with unknown SoC. Limit is removed on vehicle
disconnect. [Read more.](/en/docs/features/limit)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/power"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/loadpoints/{id}/limitsoc/{soc}:
post:
summary: Update limit SoC
description: >
Updates the SoC limit of the loadpoint. Requires a connected vehicle
with known SoC. Limit is maintained across charging sessions. [Read
more.](/en/docs/features/limit)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/soc"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/loadpoints/{id}/maxcurrent/{current}:
post:
summary: Update maximum current
description: >
Updates the maximum current of the loadpoint. [Read
more.](/en/docs/reference/configuration/loadpoints#maxcurrent)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/current"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/loadpoints/{id}/mincurrent/{current}:
post:
summary: Update minimum current
description: >
Updates the minimum current of the loadpoint. [Read
more.](/en/docs/reference/configuration/loadpoints#mincurrent)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/current"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/loadpoints/{id}/mode/{mode}:
post:
summary: Update charge mode
description: >
Changes the charging behavior of the loadpoint. [Read
more.](/en/docs/features/solar-charging)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/mode"
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
result:
$ref: "#/components/schemas/Mode"
/loadpoints/{id}/phases/{phases}:
post:
summary: Update allowed phases
description: >
Updates the allowed phases of the loadpoint. Selects the desired phase
mode for chargers with automatic phase switching. For manual phase
switching chargers (via cable or Lasttrennschalter) this value tells
evcc the actual phases. [Read
more.](/en/docs/reference/configuration/loadpoints#phases)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/phases"
responses:
"200":
$ref: "#/components/responses/NumberResult"
"400":
description: >-
Invalid phases-value. You have most likely entered the value 0 for a
wallbox that cannot switch phases automatically. [Read
more.](/en/docs/reference/configuration/loadpoints#phases)
/loadpoints/{id}/plan:
get:
summary: Plan rates
description: >
Returns the current charging plan for this loadpoint. [Read
more.](/en/docs/features/plans)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
result:
allOf:
- type: object
properties:
planId:
$ref: "#/components/schemas/Id"
- $ref: "#/components/schemas/PlanRates"
/loadpoints/{id}/plan/energy:
delete:
summary: Deletes the energy-based charging plan
description: >
Deletes the charging plan. Only available when a vehicle with unknown
SoC is connected. [Read more.](/en/docs/features/plans)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
responses:
"200":
$ref: "#/components/responses/EmptyResult"
/loadpoints/{id}/plan/energy/{power}/{timestamp}:
post:
summary: Sets an energy-based charging plan
description: >
Creates a charging plan with fixed time and energy target. Only
available when a vehicle with unknown SoC is connected. [Read
more.](/en/docs/features/plans)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/power"
- $ref: "#/components/parameters/timestamp"
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
result:
$ref: "#/components/schemas/StaticEnergyPlan"
/loadpoints/{id}/plan/repeating/preview/{soc}/{weekdays}/{hourMinuteTime}/{timezone}:
get:
summary: Repeating plan preview
description: >
Simulates a repeating charging plan and returns the result. Does not
alter the actual charging plan. [Read more.](/en/docs/features/plans)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/soc"
- $ref: "#/components/parameters/weekdays"
- $ref: "#/components/parameters/hourMinuteTime"
- $ref: "#/components/parameters/timezone"
responses:
"200":
$ref: "#/components/responses/PlanRatesResult"
/loadpoints/{id}/plan/static/preview/{type}/{goal}/{timestamp}:
get:
summary: Preview of a charging plan
description: >
Simulates a charging plan and returns the result. Does not alter the
actual charging plan. [Read more.](/en/docs/features/plans)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- name: goal
in: path
description: Energy or SoC to reach.
required: true
examples:
socAvailable:
value: 80
summary: If SoC is available => specify SoC in %
socNotAvailable:
value: 2500
summary: If SoC is not available => specify power in Watt
schema:
oneOf:
- $ref: "#/components/parameters/soc"
- $ref: "#/components/parameters/power"
- name: type
in: path
required: true
schema:
type: string
enum:
- soc
- energy
- $ref: "#/components/parameters/timestamp"
responses:
"200":
$ref: "#/components/responses/PlanRatesResult"
/loadpoints/{id}/priority/{priority}:
post:
summary: Set priority
description: >
Sets the priority of the loadpoint. [Read
more.](/en/docs/reference/configuration/loadpoints#priority)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- name: priority
in: path
description: Higher number means higher priority.
required: true
example: 2
schema:
type: integer
minimum: 0
responses:
"200":
$ref: "#/components/responses/IntegerResult"
/loadpoints/{id}/smartcostlimit:
delete:
summary: Remove smart charging cost limit
description: >
Removes the price or emission limit for fast-charging with grid energy.
[Read more.](/en/docs/features/dynamic-prices)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
responses:
"200":
$ref: "#/components/responses/NullResult"
/loadpoints/{id}/smartcostlimit/{cost}:
post:
summary: Set smart charging cost limit
description: >
Sets the price or emission limit for fast-charging with grid energy.
[Read more.](/en/docs/features/dynamic-prices)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/costLimit"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/loadpoints/{id}/vehicle:
delete:
summary: Delete vehicle
description: >
Removes the association of a vehicle to the loadpoint. Connected vehicle
is treated as guest vehicle. [Read more.](/en/docs/features/vehicle)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
responses:
"200":
$ref: "#/components/responses/EmptyResult"
patch:
summary: Start vehicle detection
description: >
Starts the automaticvehicle detection process. [Read
more.](/en/docs/features/vehicle)
tags:
- Loadpoints
responses:
"200":
$ref: "#/components/responses/EmptyResult"
/loadpoints/{id}/vehicle/{name}:
post:
summary: Assign vehicle
description: >
Changes the association of a vehicle to the loadpoint. [Read
more.](/en/docs/features/vehicle)
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/id"
- $ref: "#/components/parameters/vehicleName"
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
result:
type: object
properties:
vehicle:
$ref: "#/components/schemas/VehicleTitle"
/prioritysoc/{soc}:
post:
summary: Set battery priority SoC
description: |
Set battery priority SoC. [Read more.](/en/docs/features/battery)
tags:
- Home Battery
parameters:
- $ref: "#/components/parameters/soc"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/residualpower/{power}:
post:
summary: Set grid residual power
description: >
Sets target operating point of the control loop. [Read
more.](/en/docs/reference/configuration/site#residualpower)
tags:
- Home Battery
parameters:
- $ref: "#/components/parameters/power"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/session/{id}:
parameters:
- $ref: "#/components/parameters/id"
put:
summary: Update vehicle of charging session
description: >
Update vehicle of charging session. [Read
more.](/en/docs/features/sessions)
tags:
- Sessions
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
vehicle:
$ref: "#/components/schemas/VehicleName"
loadpoint:
$ref: "#/components/schemas/LoadpointName"
responses:
"200":
description: Success
delete:
summary: Delete charging session
description: |
Delete charging session. [Read more.](/en/docs/features/sessions)
tags:
- Sessions
responses:
"200":
$ref: "#/components/responses/NullResult"
/sessions:
get:
summary: Charging sessions
description: >
Returns a list of charging sessions. [Read
more.](/en/docs/features/sessions)
tags:
- Sessions
parameters:
- name: format
in: query
description: Response format (default json)
schema:
type: string
enum:
- csv
- name: lang
in: query
description: Language (defaults to accept header)
schema:
type: string
example: de
- name: month
in: query
description: Month filter
schema:
type: integer
example: 2
minimum: 1
maximum: 12
- name: year
in: query
description: Year filter
schema:
type: integer
example: 2025
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
result:
$ref: "#/components/schemas/ChargingSessions"
text/csv:
schema:
description: Download csv-file
type: string
format: binary
/settings/telemetry:
get:
summary: Telemetry status
description: >
Returns the current telemetry status. [Read
more.](/en/docs/reference/configuration/telemetry)
tags:
- System
responses:
"200":
$ref: "#/components/responses/BooleanResult"
/settings/telemetry/{enable}:
post:
summary: Enable/disable telemetry
description: >
Enable or disable telemetry. Note: Telemetry requires
[sponsorship](/en/docs/sponsorship). [Read
more.](/en/docs/reference/configuration/telemetry)
tags:
- System
parameters:
- $ref: "#/components/parameters/enable"
responses:
"200":
$ref: "#/components/responses/BooleanResult"
"400":
description: Sponsorship required
/smartcostlimit:
delete:
summary: Remove smart charging cost limit for all loadpoints.
description: >
Conveniance method to remove limit for all loadpoints at once. Value is
applied to each individual loadpoint.
tags:
- Loadpoints
responses:
"200":
$ref: "#/components/responses/NullResult"
/smartcostlimit/{cost}:
post:
summary: Set smart charging cost limit for all loadpoints
description: >
Conveniance method to set smart charging cost limit for all loadpoints
at once. Value is applied to each individual loadpoint.
tags:
- Loadpoints
parameters:
- $ref: "#/components/parameters/costLimit"
responses:
"200":
$ref: "#/components/responses/NumberResult"
/state:
get:
summary: System state
description: >
Returns the complete state of the system. This structure is used by the
UI. It can be filtered by [JQ](https://jqlang.github.io/jq/) to only
return a subset of the data. [Read
more.](/en/docs/reference/configuration/state)
tags:
- General
parameters:
- name: jq
in: query
description: Filter the state with JQ
schema:
type: string
examples:
all:
value: .
summary: complete state
firstLoadpoint:
value: .loadpoints[0]
summary: only first loadpoint
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
result:
$ref: "#/components/schemas/State"
/system/log:
get:
summary: Logs
description: >
Returns the latest log lines. [Read
more.](/en/docs/reference/configuration/log)
security:
- cookieAuth: []
tags:
- System
parameters:
- $ref: "#/components/parameters/logAreas"
- $ref: "#/components/parameters/logLevel"
- name: count
in: query
description: Number of log lines to return
example: 100
schema:
type: integer
- name: format
in: query
description: File type
schema:
type: string
enum:
- txt
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
result:
type: array
items:
type: string
text/plain:
schema:
description: Download txt-file
type: string
format: binary
"401":
$ref: "#/components/responses/Unauthorized"
/system/log/areas:
get:
summary: List of all log areas
description: |
Returns a list of all log areas (e.g. `lp-1`, `site`, `db`).
security:
- cookieAuth: []
tags:
- System
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
result:
$ref: "#/components/schemas/LogAreas"
"401":
$ref: "#/components/responses/Unauthorized"
/system/shutdown:
post:
summary: Shutdown evcc
description: >
Shuts down the evcc instance. There is no reboot command. We expect the
underlying system (docker, systemd, etc.) to restart the evcc instance
once it's terminated.
security:
- cookieAuth: []
tags:
- System
responses:
"204":
$ref: "#/components/responses/BlankResponse"
"401":
$ref: "#/components/responses/Unauthorized"
/tariff/{type}:
get:
summary: Tariff information
description: >
Returns the prices or emission values for the upcoming hours [Read
more.](/en/docs/devices/tariffs)
tags:
- Tariffs
parameters:
- name: type
in: path
description: Tariff type
required: true
schema:
type: string
enum:
- grid
- feedin
- co2
- planner
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
result:
type: object
properties:
rates:
$ref: "#/components/schemas/Rates"
"404":
description: Tariff not defined
/vehicles/{name}/limitsoc/{soc}:
post:
summary: Set SoC limit
description: >
Charging will stop when this SoC is reached. [Read
more.](/en/docs/features/limits)
tags:
- Vehicles
parameters:
- $ref: "#/components/parameters/vehicleName"
- $ref: "#/components/parameters/soc"
responses:
"200":
$ref: "#/components/responses/SocResult"
/vehicles/{name}/minsoc/{soc}:
post:
summary: Set minimum SoC
description: >
Vehicle will be fast-charged until this SoC is reached. [Read
more.](/en/docs/features/limits)
tags:
- Vehicles
parameters:
- $ref: "#/components/parameters/vehicleName"
- $ref: "#/components/parameters/soc"
responses:
"200":
$ref: "#/components/responses/SocResult"
/vehicles/{name}/plan/repeating:
post:
summary: Update repeating plans
description: >
Updates the repeating charging plan. [Read
more.](/en/docs/features/plans)
tags:
- Vehicles
parameters:
- $ref: "#/components/parameters/vehicleName"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RepeatingPlans"
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
result:
$ref: "#/components/schemas/RepeatingPlans"
/vehicles/{name}/plan/soc:
delete:
summary: Delete a SoC-based charging plan
description: |
Deletes the charging plan [Read more.](/en/docs/features/plans)
tags:
- Vehicles
parameters:
- $ref: "#/components/parameters/vehicleName"
responses:
"200":
$ref: "#/components/responses/EmptyResult"
/vehicles/{name}/plan/soc/{soc}/{timestamp}:
post:
summary: Set a SoC-based charging plan
description: >
Creates a charging plan with fixed time and SoC target. [Read
more.](/en/docs/features/plans)
tags:
- Vehicles
parameters:
- $ref: "#/components/parameters/vehicleName"
- $ref: "#/components/parameters/soc"
- $ref: "#/components/parameters/timestamp"
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
result:
$ref: "#/components/schemas/StaticSocPlan"
components:
schemas:
ChangePassword:
type: object
properties:
current:
$ref: "#/components/schemas/Password"
new:
$ref: "#/components/schemas/Password"
ChargingSessions:
description: Charging sessions
type: array
items:
type: object
properties:
id:
$ref: "#/components/schemas/Id"
created:
$ref: "#/components/schemas/Timestamp"
finished:
$ref: "#/components/schemas/Timestamp"
loadpoint:
$ref: "#/components/schemas/LoadpointName"
vehicle:
$ref: "#/components/schemas/VehicleName"
odometer:
type: number
nullable: true
description: Vehicle odometer reading in kilometers
meterStart:
type: number
nullable: true
description: Meter reading at start of charging session
meterStop: