Notes
These are a collection of endpoints that allow you to configure Bird notes.
Get Bird Note
GET /api/v1/device/note
Retrieve a Bird's note.
Required Parameters
auth_token string
A valid auth token
node_id string
A valid Canary node_id
Response
JSON structure with the Bird note.
Example
curl https://EXAMPLE.canary.tools/api/v1/device/note \
-d auth_token=EXAMPLE_AUTH_TOKEN \
-d node_id=EXAMPLE_NODE_ID \
-G
1
2
3
4
import requests
url = 'https://EXAMPLE.canary.tools/api/v1/device/note'
payload = {
'auth_token': 'EXAMPLE_AUTH_TOKEN',
'node_id': 'EXAMPLE_NODE_ID'
}
r = requests.get(url, params=payload)
print(r.json())
1
2
3
4
5
6
7
8
9
10
11
12
{
"note": "Example Bird Note",
"result": "success"
}
1
2
3
4
Add Bird Note
POST /api/v1/device/note/add
Add a note to a specified Bird.
Required Parameters
auth_token string
A valid auth token
node_id string
A valid Canary node_id
note string
A note for the Bird
Response
JSON structure with the result indicator.
Example
curl https://EXAMPLE.canary.tools/api/v1/device/note/add \
-d auth_token=EXAMPLE_AUTH_TOKEN \
-d node_id=EXAMPLE_NODE_ID \
-d note='Example Bird Note'
1
2
3
4
import requests
url = 'https://EXAMPLE.canary.tools/api/v1/device/note/add'
payload = {
'auth_token': 'EXAMPLE_AUTH_TOKEN',
'node_id': 'EXAMPLE_NODE_ID',
'note': 'Example bird note'
}
r = requests.post(url, data=payload)
print(r.json())
1
2
3
4
5
6
7
8
9
10
11
12
13
{
"result": "success"
}
1
2
3
Delete Bird Note
POST /api/v1/device/note/delete
Delete the note for a specified Bird.
Required Parameters
auth_token string
A valid auth token
node_id string
A valid Canary node_id
Response
JSON structure with the result indicator.
Example
curl https://EXAMPLE.canary.tools/api/v1/device/note/delete \
-d auth_token=EXAMPLE_AUTH_TOKEN \
-d node_id=EXAMPLE_NODE_ID
1
2
3
import requests
url = 'https://EXAMPLE.canary.tools/api/v1/device/note/delete'
payload = {
'auth_token': 'EXAMPLE_AUTH_TOKEN',
'node_id': 'EXAMPLE_NODE_ID',
}
r = requests.post(url, data=payload)
print(r.json())
1
2
3
4
5
6
7
8
9
10
11
12
{
"result": "success"
}
1
2
3
