# 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

    Response
    {
      "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

      Response
      {
        "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

        Response
        {
          "result": "success"
        }
        
        1
        2
        3