--- title: "Partial update an existing monitor" method: PATCH path: "/monitors/{id}" tags: ["Monitors"] --- # Partial update an existing monitor `PATCH /monitors/{id}` ## Path parameters - `id` string, required ## Headers - `x-apikey` string, required - `Accept` string, required - `Content-Type` string, required ## Request body - Monitor — A monitor defines 1 or more conditions and an optional doc query string to use for matching documents of interest. Matching a document results in the creation of an alert. - `created_at` string, date-time — The timestamp the monitor was created. - `created_by_user_email` string — The user's name that created the monitor. - `created_by_user_id` string — The ID of the user that created the monitor. - `description` string — The description of the monitor. - `doc_condition` Condition, required — A Condition forms the basis for querying topics and labels in monitors. It can be used to form complex conditions using all/any as well as specifying specific values to match for documents. See the user guide for more details. - `match` Condition[], required — The match values, or sub Conditions. - `operator` 'must_equal' | 'must_not_equal' | 'must_start_with' | 'must_not_start_with' | 'must_end_with' | 'must_not_end_with' | 'must_contain' | 'must_not_contain' | 'any' | 'all', required — The operator to use for this Condition. - `topic` 'doc_type' | 'source' | 'match_conditions' | 'credential_domain' | 'typosquatted_domain' | 'keyword' | 'lucene' | 'group_bin' | 'group_brand' | 'group_crypto' | 'group_hash' | 'group_identity' | 'group_keys' | 'group_location' | 'group_network' | 'group_paths' | 'group_social' | 'group_threats' | 'label_industry' | 'label_language' | 'label_threat' | 'label_type' | 'bin' | 'bin_foreign' | 'bin_partial' | 'organization' | 'product' | 'name' | 'brand' | 'product_batch_name' | 'atom_address' | 'bch_address' | 'btc_address' | 'dash_address' | 'doge_address' | 'ltc_address' | 'xlm_address' | 'xmr_address' | 'zec_address' | 'sha1_hash' | 'sha256_hash' | 'md5_hash' | 'client_identifier' | 'email_address' | 'identity_name' | 'twitter_handle' | 'telegram_user_name' | 'phone_number' | 'access_token' | 'crypto_key_private' | 'crypto_key_public' | 'password_plaintext' | 'predict_password_plaintext' | 'location_name' | 'city' | 'country' | 'ipv4_address' | 'ipv6_address' | 'domain' | 'mac_address' | 'url' | 'filename' | 'path' | 'registry_key' | 'hashtag' | 'icq_uin' | 'jid' | 'cve' | 'threat_name' | 'threat_group_name' | 'service_name' | 'cwe', required — The topic to apply this Condition to. - `email_notify_enabled` boolean — If email notifications are enabled for this monitor. - `email_notify_immediate` boolean — If immediate email delivery is enabled for this monitor. - `enabled` boolean — If the monitor is enabled or not. - `id` string — The ID of the monitor. - `last_updated_by_user_id` string — The ID of the user that last updated the monitor. - `last_updated_user_email` string — The user's name that last updated the monitor. - `name` string — The name of the monitor. - `password_policy` PasswordPolicy — Criteria defining a password policy. - `length_max` integer — The maxium length of the password in order to meet the policy. - `length_min` integer — The minimum length of the password in order to meet the policy. - `lowercase_char_count` integer — The minimum numer of lowercase characters a password is expected to have in order to meet the policy. - `lowercase_char_required` boolean — If true, then the password is expected to have lowercase characters in order to meet the policy. - `numbers_count` integer — The minimum numer of numerical characters a password is expected to have in order to meet the policy. - `numbers_required` boolean — If true, then the password is expected to have numerical characters in order to meet the policy. - `special_char_count` integer — The minimum numer of special case characters a password is expected to have in order to meet the policy. - `special_char_required` boolean — If true, then the password is expected to have special case characters in order to meet the policy. - `uppercase_char_count` integer — The minimum numer of uppercase characters a password is expected to have in order to meet the policy. - `uppercase_char_required` boolean — If true, then the password is expected to have uppercase characters in order to meet the policy. - `template_id` string — If a monitor was created from a template, then this field is populated with the template's ID. It cannot be changed after creation. - `updated_at` string, date-time — The timestamp the monitor was last updated. - `version` integer — The version number for the monitor. A monitor's version is incremented each time the monitor is updated. ## Response `200` OK - Monitor — A monitor defines 1 or more conditions and an optional doc query string to use for matching documents of interest. Matching a document results in the creation of an alert. - `created_at` string, date-time — The timestamp the monitor was created. - `created_by_user_email` string — The user's name that created the monitor. - `created_by_user_id` string — The ID of the user that created the monitor. - `description` string — The description of the monitor. - `doc_condition` Condition, required — A Condition forms the basis for querying topics and labels in monitors. It can be used to form complex conditions using all/any as well as specifying specific values to match for documents. See the user guide for more details. - `match` Condition[], required — The match values, or sub Conditions. - `operator` 'must_equal' | 'must_not_equal' | 'must_start_with' | 'must_not_start_with' | 'must_end_with' | 'must_not_end_with' | 'must_contain' | 'must_not_contain' | 'any' | 'all', required — The operator to use for this Condition. - `topic` 'doc_type' | 'source' | 'match_conditions' | 'credential_domain' | 'typosquatted_domain' | 'keyword' | 'lucene' | 'group_bin' | 'group_brand' | 'group_crypto' | 'group_hash' | 'group_identity' | 'group_keys' | 'group_location' | 'group_network' | 'group_paths' | 'group_social' | 'group_threats' | 'label_industry' | 'label_language' | 'label_threat' | 'label_type' | 'bin' | 'bin_foreign' | 'bin_partial' | 'organization' | 'product' | 'name' | 'brand' | 'product_batch_name' | 'atom_address' | 'bch_address' | 'btc_address' | 'dash_address' | 'doge_address' | 'ltc_address' | 'xlm_address' | 'xmr_address' | 'zec_address' | 'sha1_hash' | 'sha256_hash' | 'md5_hash' | 'client_identifier' | 'email_address' | 'identity_name' | 'twitter_handle' | 'telegram_user_name' | 'phone_number' | 'access_token' | 'crypto_key_private' | 'crypto_key_public' | 'password_plaintext' | 'predict_password_plaintext' | 'location_name' | 'city' | 'country' | 'ipv4_address' | 'ipv6_address' | 'domain' | 'mac_address' | 'url' | 'filename' | 'path' | 'registry_key' | 'hashtag' | 'icq_uin' | 'jid' | 'cve' | 'threat_name' | 'threat_group_name' | 'service_name' | 'cwe', required — The topic to apply this Condition to. - `email_notify_enabled` boolean — If email notifications are enabled for this monitor. - `email_notify_immediate` boolean — If immediate email delivery is enabled for this monitor. - `enabled` boolean — If the monitor is enabled or not. - `id` string — The ID of the monitor. - `last_updated_by_user_id` string — The ID of the user that last updated the monitor. - `last_updated_user_email` string — The user's name that last updated the monitor. - `name` string — The name of the monitor. - `password_policy` PasswordPolicy — Criteria defining a password policy. - `length_max` integer — The maxium length of the password in order to meet the policy. - `length_min` integer — The minimum length of the password in order to meet the policy. - `lowercase_char_count` integer — The minimum numer of lowercase characters a password is expected to have in order to meet the policy. - `lowercase_char_required` boolean — If true, then the password is expected to have lowercase characters in order to meet the policy. - `numbers_count` integer — The minimum numer of numerical characters a password is expected to have in order to meet the policy. - `numbers_required` boolean — If true, then the password is expected to have numerical characters in order to meet the policy. - `special_char_count` integer — The minimum numer of special case characters a password is expected to have in order to meet the policy. - `special_char_required` boolean — If true, then the password is expected to have special case characters in order to meet the policy. - `uppercase_char_count` integer — The minimum numer of uppercase characters a password is expected to have in order to meet the policy. - `uppercase_char_required` boolean — If true, then the password is expected to have uppercase characters in order to meet the policy. - `template_id` string — If a monitor was created from a template, then this field is populated with the template's ID. It cannot be changed after creation. - `updated_at` string, date-time — The timestamp the monitor was last updated. - `version` integer — The version number for the monitor. A monitor's version is incremented each time the monitor is updated. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `404` — Not Found - `500` — Internal Server Error --- [API](https://skmtc.net/virustotal/apis/threat-landscape.md) · [All operations](https://skmtc.net/virustotal/apis/threat-landscape/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/virustotal/threat-landscape/versions/d61b85e6a6b3/schema)