# Notifications

# Disable Bird Disconnect Notifications

POST /api/v1/device/notifications/disconnects/disable

Disable a Bird's disconnect notifications.

Required Parameters

auth_token string
A valid auth token
node_id string
A valid Canary node_id

Response

JSON structure with result indicator and Bird data.

Example

    Response
    {
      "device": {
        "autoreg_time": "1585678633.528495",
        "current_settings": "devicesettings:<device_hash>:1585762137",
        "description": "SRV Room",
        "device_id": "<device_id>",
        "device_id_hash": "<device_hash>",
        "device_live": "True",
        "device_version": "2.2",
        "first_seen": "1585680957",
        "flock_id": "flock:default",
        "ghost": "False",
        "id": "<node_id>",
        "ignore_notifications_disconnect": true,
        "ignore_notifications_general": "False",
        "ip_address": "192.168.1.2",
        "ippers": "linux",
        "last_dns_settings_message_time": "2020-04-01 17:28:23",
        "last_heartbeat": "1585762408",
        "live": "False",
        "local_time": "2020-04-01 17:32:54",
        "logtype": "1004",
        "mac": "00:00:00:00:00:00",
        "mac_address": "00:00:00:00:00:00",
        "name": "ExampleBird",
        "need_reboot": "False",
        "netmask": "24",
        "node_id": "<node_id>",
        "note": "Example Bird Note",
        "reconnect_count": "0",
        "sensor": "thinkstcanary",
        "service_count": "20",
        "update_attempts:2.1": "1",
        "update_attempts:2.1.1": "1",
        "uptime": "288",
        "was_rollback": "False"
      },
      "result": "success"
    }
    
    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

    # Enable Bird Disconnect Notifications

    POST /api/v1/device/notifications/disconnects/enable

    Enable a Bird's disconnect notifications.

    Required Parameters

    auth_token string
    A valid auth token
    node_id string
    A valid Canary node_id

    Response

    JSON structure with result indicator and Bird data.

    Example

      Response
      {
        "device": {
          "autoreg_time": "1585678633.528495",
          "current_settings": "devicesettings:<device_hash>:1585762137",
          "description": "SRV Room",
          "device_id": "<device_id>",
          "device_id_hash": "<device_hash>",
          "device_live": "True",
          "device_version": "2.2",
          "first_seen": "1585680957",
          "flock_id": "flock:default",
          "ghost": "False",
          "id": "<node_id>",
          "ignore_notifications_disconnect": false,
          "ignore_notifications_general": "False",
          "ip_address": "192.168.1.2",
          "ippers": "linux",
          "last_dns_settings_message_time": "2020-04-01 17:28:23",
          "last_heartbeat": "1585764208",
          "live": "False",
          "local_time": "2020-04-01 18:02:54",
          "logtype": "1004",
          "mac": "00:00:00:00:00:00",
          "mac_address": "00:00:00:00:00:00",
          "name": "ExampleBird",
          "need_reboot": "False",
          "netmask": "24",
          "node_id": "<node_id>",
          "note": "Example Bird Note",
          "reconnect_count": "0",
          "sensor": "thinkstcanary",
          "service_count": "20",
          "update_attempts:2.1": "1",
          "update_attempts:2.1.1": "1",
          "uptime": "2088",
          "was_rollback": "False"
        },
        "result": "success"
      }
      
      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

      # Disable Bird Incident Notifications

      POST /api/v1/device/notifications/incidents/disable

      Disable a Bird's incident notifications.

      Required Parameters

      auth_token string
      A valid auth token
      node_id string
      A valid Canary node_id

      Response

      JSON structure with result indicator and Bird data.

      Example

        Response
        {
          "device": {
            "autoreg_time": "1585678633.528495",
            "current_settings": "devicesettings:<device_hash>:1585762137",
            "description": "SRV Room",
            "device_id": "<node_id>",
            "device_id_hash": "<device_hash>",
            "device_live": "True",
            "device_version": "2.2",
            "first_seen": "1585680957",
            "flock_id": "flock:default",
            "ghost": "False",
            "id": "<node_id>",
            "ignore_notifications_disconnect": "False",
            "ignore_notifications_general": true,
            "ip_address": "192.168.1.2",
            "ippers": "linux",
            "last_dns_settings_message_time": "2020-04-01 17:28:23",
            "last_heartbeat": "1585765411",
            "live": "False",
            "local_time": "2020-04-01 18:22:54",
            "logtype": "1004",
            "mac": "00:00:00:00:00:00",
            "mac_address": "00:00:00:00:00:00",
            "name": "ExampleBird",
            "need_reboot": "False",
            "netmask": "24",
            "node_id": "<node_id>",
            "note": "Example Bird Note",
            "reconnect_count": "0",
            "sensor": "thinkstcanary",
            "service_count": "20",
            "throttled": false,
            "update_attempts:2.1": "1",
            "update_attempts:2.1.1": "1",
            "uptime": "3288",
            "was_rollback": "False"
          },
          "result": "success"
        }
        
        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

        # Enable Bird Incident Notifications

        POST /api/v1/device/notifications/incidents/enable

        Enable a Bird's incident notifications.

        Required Parameters

        auth_token string
        A valid auth token
        node_id string
        A valid Canary node_id

        Response

        JSON structure with result indicator and Bird data.

        Example

          Response
          {
            "device": {
              "autoreg_time": "1585678633.528495",
              "current_settings": "devicesettings:<device_hash>:1585762137",
              "description": "SRV Room",
              "device_id": "<node_id>",
              "device_id_hash": "<device_hash>",
              "device_live": "True",
              "device_version": "2.2",
              "first_seen": "1585680957",
              "flock_id": "flock:default",
              "ghost": "False",
              "id": "<node_id",
              "ignore_notifications_disconnect": "False",
              "ignore_notifications_general": false,
              "ip_address": "192.168.1.2",
              "ippers": "linux",
              "last_dns_settings_message_time": "2020-04-01 17:28:23",
              "last_heartbeat": "1585765891",
              "live": "False",
              "local_time": "2020-04-01 18:30:54",
              "logtype": "1004",
              "mac": "00:00:00:00:00:00",
              "mac_address": "00:00:00:00:00:00",
              "name": "ExampleBird",
              "need_reboot": "False",
              "netmask": "24",
              "node_id": "<node_id",
              "note": "Example Bird Note",
              "reconnect_count": "0",
              "sensor": "thinkstcanary",
              "service_count": "20",
              "throttled": "False",
              "update_attempts:2.1": "1",
              "update_attempts:2.1.1": "1",
              "uptime": "3768",
              "was_rollback": "False"
            },
            "result": "success"
          }
          
          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

          # Disable Bird Reconnect Notifications

          POST /api/v1/device/notifications/reconnects/disable

          Disable a Bird's reconnect notifications.

          Required Parameters

          auth_token string
          A valid auth token
          node_id string
          A valid Canary node_id

          Response

          JSON structure with result indicator and Bird data.

          Example

            Response
            {
              "device": {
                "autoreg_time": "1585678633.528495",
                "current_settings": "devicesettings:<device_hash>:1585762137",
                "description": "SRV Room",
                "device_id": "<node_id>",
                "device_id_hash": "<device_hash>",
                "device_live": "True",
                "device_version": "2.2",
                "first_seen": "1585680957",
                "flock_id": "flock:default",
                "ghost": "False",
                "id": "<node_id",
                "ignore_notifications_disconnect": "False",
                "ignore_notifications_general": "False",
                "ignore_notifications_reconnect": true,
                "ip_address": "192.168.1.2",
                "ippers": "linux",
                "last_dns_settings_message_time": "2020-04-01 17:28:23",
                "last_heartbeat": "1585766131",
                "live": "False",
                "local_time": "2020-04-01 18:34:54",
                "logtype": "1004",
                "mac": "00:00:00:00:00:00",
                "mac_address": "00:00:00:00:00:00",
                "name": "ExampleBird",
                "need_reboot": "False",
                "netmask": "24",
                "node_id": "<node_id>",
                "note": "Example Bird Note",
                "reconnect_count": "0",
                "sensor": "thinkstcanary",
                "service_count": "20",
                "throttled": "False",
                "update_attempts:2.1": "1",
                "update_attempts:2.1.1": "1",
                "uptime": "4008",
                "was_rollback": "False"
              },
              "result": "success"
            }
            
            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

            # Enable Bird Reconnect Notifications

            POST /api/v1/device/notifications/reconnects/enable

            Enable a Bird's reconnect notifications.

            Required Parameters

            auth_token string
            A valid auth token
            node_id string
            A valid Canary node_id

            Response

            JSON structure with result indicator and Bird data.

            Example

              Response
              {
                "device": {
                  "autoreg_time": "1585678633.528495",
                  "current_settings": "devicesettings:<device_hash>:1585762137",
                  "description": "SRV Room",
                  "device_id": "<node_id>",
                  "device_id_hash": "<device_hash>",
                  "device_live": "True",
                  "device_version": "2.2",
                  "first_seen": "1585680957",
                  "flock_id": "flock:default",
                  "ghost": "False",
                  "id": "<node_id>",
                  "ignore_notifications_disconnect": "False",
                  "ignore_notifications_general": "False",
                  "ignore_notifications_reconnect": false,
                  "ip_address": "192.168.1.2",
                  "ippers": "linux",
                  "last_dns_settings_message_time": "2020-04-01 17:28:23",
                  "last_heartbeat": "1585766549",
                  "live": "False",
                  "local_time": "2020-04-01 18:41:54",
                  "logtype": "1004",
                  "mac": "00:00:00:00:00:00",
                  "mac_address": "00:00:00:00:00:00",
                  "name": "ExampleBird",
                  "need_reboot": "False",
                  "netmask": "24",
                  "node_id": "<node_id>",
                  "note": "Example Bird Note",
                  "reconnect_count": "0",
                  "sensor": "thinkstcanary",
                  "service_count": "20",
                  "throttled": "False",
                  "update_attempts:2.1": "1",
                  "update_attempts:2.1.1": "1",
                  "uptime": "4428",
                  "was_rollback": "False"
                },
                "result": "success"
              }
              
              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