Notes

These are a collection of endpoints that allow you to configure Flock notes.

Endpoints

GET /api/v1/flock/note

POST /api/v1/flock/note/add

DELETE /api/v1/flock/note/delete

Get Flock Note

GET /api/v1/flock/note

Retrieve a Flock's note.

Required Parameters

auth_token string

A valid auth token

flock_id string

A valid flock_id

Response

JSON structure with the Flock note.

Example

curl https://EXAMPLE.canary.tools/api/v1/flock/note \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d flock_id=EXAMPLE_FLOCK_ID \
  -G

import requests

url = 'https://EXAMPLE.canary.tools/api/v1/flock/note'

payload = {
  'auth_token': 'EXAMPLE_AUTH_TOKEN',
  'flock_id':'EXAMPLE_FLOCK_ID'
}

r = requests.get(url, params=payload)

print(r.json())

Response

{
  "note": "Example Flock Note",
  "result": "success"
}

Add Flock Note

POST /api/v1/flock/note/add

Add a note to a specified Flock.

Required Parameters

auth_token string

A valid auth token

flock_id string

A valid flock_id

note string

A note for the Flock

Response

JSON structure with the result indicator.

Example

curl https://EXAMPLE.canary.tools/api/v1/flock/note/add \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d flock_id=EXAMPLE_FLOCK_ID \
  -d note='EXAMPLE_FLOCK_NOTE'

import requests

url = 'https://EXAMPLE.canary.tools/api/v1/flock/note/add'

payload = {
  'auth_token': 'EXAMPLE_AUTH_TOKEN',
  'flock_id':'EXAMPLE_FLOCK_ID',
  'note': 'EXAMPLE_FLOCK_NOTE'
}

r = requests.post(url, data=payload)

print(r.json())

Response

{
  "result": "success"
}

Delete Flock Note

DELETE /api/v1/flock/note/delete

Delete the note for a specified Flock.

Required Parameters

auth_token string

A valid auth token

flock_id string

A valid flock_id

Response

JSON structure with the result indicator.

Example

curl -X DELETE https://EXAMPLE.canary.tools/api/v1/flock/note/delete \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d flock_id=EXAMPLE_FLOCK_ID 

import requests

url = 'https://EXAMPLE.canary.tools/api/v1/flock/note/delete'

payload = {
  'auth_token': 'EXAMPLE_AUTH_TOKEN',
  'flock_id':'EXAMPLE_FLOCK_ID'
}

r = requests.delete(url, data=payload)

print(r.json())

Response

{
  "result": "success"
}