# Notification Settings

# Change Alerts

Unexpected changes to Bird or Console settings can be a sign that someone is playing around where they shouldn't be. We allow for you to enable alerting in these cases, letting you know as soon as someone makes a change.

# Disable Console Settings Change Alerts

POST /api/v1/settings/console_settings_change/disable

Disable Console settings change alerts.

Required Parameters

auth_token string
A valid auth token

Response

A JSON structure with result indicator.

Example

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

    # Enable Console Settings Change Alerts

    POST /api/v1/settings/console_settings_change/enable

    Enable Console settings change alerts.

    Required Parameters

    auth_token string
    A valid auth token

    Response

    A JSON structure with result indicator.

    Example

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

      # Disable Device Settings Change Alerts

      POST /api/v1/settings/device_settings_change/disable

      Disable Device settings change alerts.

      Required Parameters

      auth_token string
      A valid auth token

      Response

      A JSON structure with result indicator.

      Example

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

        # Enable Device Settings Change Alerts

        POST /api/v1/settings/device_settings_change/enable

        Enable Device settings change alerts.

        Required Parameters

        auth_token string
        A valid auth token

        Response

        A JSON structure with result indicator.

        Example

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

          # Data Masking

          When we create alerts, they will include sensitive information such as the credentials used. Now, we think that having this information is good as you'll want to change those creds in any case, but we do give you the ability to mask this information in the alert details.

          # Disable Data Masking

          POST /api/v1/settings/notifications/masking/disable

          Disable masking of details in alert notifications.

          Required Parameters

          auth_token string
          A valid auth token

          Response

          A JSON structure with result indicator.

          Example

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

            # Enable Data Masking

            POST /api/v1/settings/notifications/masking/enable

            Enable masking of details in alert notifications.

            Required Parameters

            auth_token string
            A valid auth token

            Response

            A JSON structure with result indicator.

            Example

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

              # Summary Emails

              If you want, we can send you a weekly summary of your Console activity. Along with that, we'll include any Canary related news that we deem useful (this usually includes a couple worthy news items).

              Simply enable and set a list of email addresses and lookout for the weekly mail on Mondays!

              # Disable Summary Emails

              POST /api/v1/settings/notifications/summary_email/disable

              Disable weekly summary emails for your Console.

              Required Parameters

              auth_token string
              A valid auth token

              Response

              A JSON structure with result indicator.

              Example

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

                # Enable Summary Emails

                POST /api/v1/settings/notifications/summary_email/enable

                Enable weekly summary emails for your Console.

                Required Parameters

                auth_token string
                A valid auth token

                Response

                A JSON structure with result indicator.

                Example

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

                  # Set Summary Emails

                  POST /api/v1/settings/notifications/summary_email/save

                  Set the list of email addresses that will receive the weekly summary emails.

                  Required Parameters

                  auth_token string
                  A valid auth token

                  Optional Parameters

                  addresses string
                  A comma separated list of email addresses
                  clear boolean
                  If set to true, clears the list of cellphone numbers

                  TIP

                  At least one of the optional parameters is required.

                  Response

                  A JSON structure with result indicator.

                  Example

                    Response
                    {
                      "emails": "<email_address>,<email_address>",
                      "result": "success"
                    }
                    
                    1
                    2
                    3
                    4