@@ -54,7 +54,7 @@ Successful calls will return status code 200 or 201. Other status codes that can
54
54
The API supports the following actions:
55
55
56
56
#### {% linkable_title GET /api/ %}
57
- Returns message if API is up and running.
57
+ Returns a message if the API is up and running.
58
58
59
59
``` json
60
60
{
@@ -142,7 +142,7 @@ $ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \
142
142
```
143
143
144
144
#### {% linkable_title GET /api/events %}
145
- Returns an array of event objects. Each event object contain event name and listener count.
145
+ Returns an array of event objects. Each event object contains event name and listener count.
146
146
147
147
``` json
148
148
[
@@ -193,7 +193,7 @@ $ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \
193
193
```
194
194
195
195
#### {% linkable_title GET /api/history %}
196
- Returns an array of state changes in the past. Each object contains further detail for the entities.
196
+ Returns an array of state changes in the past. Each object contains further details for the entities.
197
197
198
198
``` json
199
199
[
@@ -377,7 +377,7 @@ Returns a message if successful.
377
377
```
378
378
379
379
#### {% linkable_title POST /api/services/< ; domain>/< ; service> %}
380
- Calls a service within a specific domain. Will return when the service has been executed or 10 seconds has past , whichever comes first.
380
+ Calls a service within a specific domain. Will return when the service has been executed or after 10 seconds, whichever comes first.
381
381
382
382
You can pass an optional JSON object to be used as ` service_data ` .
383
383
@@ -416,7 +416,7 @@ $ curl -X POST -H "x-ha-access: YOUR_PASSWORD" \
416
416
```
417
417
418
418
<p class =' note ' >
419
- The result will include any changed states that changed while the service was being executed, even if their change was the result of something else happening in the system.
419
+ The result will include any states that changed while the service was being executed, even if their change was the result of something else happening in the system.
420
420
</p >
421
421
422
422
#### {% linkable_title POST /api/template %}
@@ -443,7 +443,7 @@ $ curl -X POST -H "x-ha-access: YOUR_PASSWORD" \
443
443
```
444
444
445
445
#### {% linkable_title POST /api/event_forwarding %}
446
- Setup event forwarding to another Home Assistant instance.
446
+ Set up event forwarding to another Home Assistant instance.
447
447
448
448
Requires a JSON object that represents the API to forward to.
449
449
@@ -455,7 +455,7 @@ Requires a JSON object that represents the API to forward to.
455
455
}
456
456
```
457
457
458
- It will return a message if event forwarding was setup successful .
458
+ It will return a message if event forwarding was set up successfully .
459
459
460
460
``` json
461
461
{
@@ -476,7 +476,7 @@ Requires a JSON object that represents the API to cancel forwarding to.
476
476
}
477
477
```
478
478
479
- It will return a message if event forwarding was cancelled successful .
479
+ It will return a message if event forwarding was cancelled successfully .
480
480
481
481
``` json
482
482
{
0 commit comments