/watcher/{watcher_id}

Developing

PUT/watcher/{watcher_id}

Last modified: 2 months ago

Updates an AI watcher
Parameters are the same as for /watcher/create.
The id of the watcher to be updated is provided in URL, e.g.

/watcher/123

Request

Path Params

watcher_id

string

required

Body Params application/x-www-form-urlencoded

alert

string

optional

Boolean: Whether the watcher should be configured to alert. Defaults to false if not specified. Example: true.

chips

string

optional

Comma-separated list of chips to create the watcher with. Example: cpu,idle.

name

string

optional

A name for the watcher. Example: My Brand New Watcher.

alert_slack_channel

string

optional

A slack channel to alert to. Example: anomify-alerts.

expiration_time

string

optional

Expiration time for alerts, specified in seconds Must be a minimum of 900 seconds (15 minutes).

alert_email_recipient_ids

string

optional

Comma-separated list of user ids to receive real-time alerts by email. Example: 101,102.

mention_slack_recipient_ids

string

optional

Comma-separated list of user ids to receive real-time alerts by SMS. Example: 101,102.

alert_teams_webhook_url

string

optional

A Microsoft Teams webhook to alert to. Example: https://xxx.webhook.office.com/abcdef.

Request samples

Responses

An example Response(200)

An example Response

HTTP Code: 200

Content Type : JSONapplication/json

status

#/definitions/875319

required

data

object

required

watcher

object

required

{
  "status": {
    "created_timestamp": 1701169087,
    "created_string": "Tue 28 Nov 2023 @ 10:58 (GMT)",
    "duration": 0.053,
    "language": "en-gb",
    "timezone": {
      "timezone_type": 3,
      "timezone": "Europe/London"
    },
    "code": 200,
    "oldest_cached_component_age": 383,
    "session_id": "5624e394cf1d3eaf5a136c9f1dc009e7",
    "org_onboarding_status_id": 300,
    "org_upgraded": 100000,
    "api_host": "anomalarm.dev.dropbox.dev.local",
    "user_onboarding_flags": {
      "main_intro": false,
      "alerts_intro": false,
      "alerts_from_search": false,
      "training_intro": true,
      "alert_created": true,
      "test_alert_sent": false,
      "two_alerts_sent": false,
      "pattern_trained": false,
      "seen_card_anomalies": false,
      "seen_card_matches": false,
      "seen_card_training": false,
      "seen_card_all": false
    }
  },
  "data": {
    "watcher": {
      "id": 293,
      "type": "ai",
      "name": "Great Lakes bush viper",
      "is_alert": true,
      "is_deleted": false,
      "expiration_time_seconds": 3600,
      "owner": {
        "id": 101,
        "org_id": 101,
        "name": "undefined",
        "email": "si@anomify.ai",
        "phone_number": "",
        "slack_member_id": "",
        "demo": false,
        "org_admin": true,
        "system_admin": true,
        "org": {
          "id": 101,
          "name": "undefined",
          "timezone": "Europe/London",
          "alert_muting": {
            "muted": false,
            "muted_until_timestamp": null,
            "muted_until_timestamp_string": null,
            "minutes_remaining": null
          },
          "onboarding_status_id": 300,
          "connected_services": {
            "slack": false,
            "ms_teams": false
          }
        },
        "notifications": {
          "email_alerts": false
        },
        "onboarding_flags": {
          "main_intro": false,
          "alerts_intro": false,
          "alerts_from_search": false,
          "training_intro": true,
          "alert_created": true,
          "test_alert_sent": false,
          "two_alerts_sent": false,
          "pattern_trained": false,
          "seen_card_anomalies": false,
          "seen_card_matches": false,
          "seen_card_training": false,
          "seen_card_all": false
        }
      }
    }
  }
}

Last modified: 2 months ago