{"basePath":"/api/v3","definitions":{"Blackout":{"description":"Blackouts","properties":{"assoc_id":{"description":"Associated Monitor or Recipient ID for Blackout","type":"integer"},"date_added":{"description":"Timestamp blackout was added","format":"date-time","readOnly":true,"type":"string"},"end_day":{"description":"End day of week (Sunday=1)","maximum":7,"minimum":1,"type":"integer"},"end_time":{"description":"End time (hh:mm)","format":"time_24_hhmm","type":"string"},"from_date":{"description":"Start datetime","format":"timestamp","type":"string"},"id":{"description":"Blackout id","type":"integer"},"login":{"description":"User who added blackout","readOnly":true,"type":"string"},"note":{"description":"Blackout note (Monitor or Alert only)","maxLength":255,"type":"string"},"persistent":{"description":"Blackout re-occurs each week","type":"boolean"},"start_day":{"description":"Start day of week (Sunday=1)","maximum":7,"minimum":1,"type":"integer"},"start_time":{"description":"Start time (hh:mm)","format":"time_24_hhmm","type":"string"},"thru_date":{"description":"End datetime","format":"timestamp","type":"string"},"type":{"description":"Type of blackout","enum":["Monitor","Alert","Notifier"],"type":"string"}},"required":["id","assoc_id","type"],"type":"object"},"BlackoutBulkEdit":{"description":"Blackout Bulk Edit","properties":{"monitors":{"description":"Integer representing monitor id.","items":{"description":"Integer representing monitor id.","type":"integer"},"type":"array"},"one_time_blackouts":{"description":"One-Time Blackouts","items":{"$ref":"#/definitions/BlackoutOneTime"},"type":"array"},"persistent_blackouts":{"description":"Persistent Blackouts","items":{"$ref":"#/definitions/BlackoutPersistent"},"type":"array"},"update_one_time":{"description":"Update One-Time Exclusion Periods","type":"boolean"},"update_one_time_action":{"description":"Append or Replace Existing Exclusion Periods","enum":["append","replace"],"type":"string"},"update_persistent":{"description":"Update Persistent Blackouts","type":"boolean"},"update_persistent_action":{"description":"Append or Replace Existing Persistent Blackouts","enum":["append","replace"],"type":"string"}},"required":["update_one_time","update_persistent","monitors"],"type":"object"},"BlackoutOneTime":{"description":"One Time Blackouts","properties":{"from_date":{"description":"Start datetime","format":"timestamp","type":"string"},"note":{"description":"Blackout note","maxLength":255,"type":"string"},"thru_date":{"description":"End datetime","format":"timestamp","type":"string"},"type":{"description":"Type of blackout","enum":["Monitor","Alert"],"type":"string"}},"required":["type","from_date","thru_date"],"type":"object"},"BlackoutPersistent":{"description":"Persistent Blackouts","properties":{"end_day":{"description":"End day of week (Sunday=1)","maximum":7,"minimum":1,"type":"integer"},"end_time":{"description":"End time (hh:mm)","format":"time_24_hhmm","type":"string"},"start_day":{"description":"Start day of week (Sunday=1)","maximum":7,"minimum":1,"type":"integer"},"start_time":{"description":"Start time (hh:mm)","format":"time_24_hhmm","type":"string"},"type":{"description":"Type of blackout","enum":["Monitor","Alert"],"type":"string"}},"required":["type","start_day","start_time","end_day","end_time"],"type":"object"},"Event":{"description":"Event Reporting","properties":{"description":{"description":"Event Description","maxLength":65535,"type":"string"},"event":{"description":"Event Type","type":"string"},"login":{"description":"Login of user","readOnly":true,"type":"string"},"name":{"description":"Event name","readOnly":true,"type":"string"},"quantity":{"description":"Event quantity","type":"integer"},"timestamp":{"description":"Timestamp of event","format":"timestamp","readOnly":true,"type":"string"},"value":{"description":"Event value","maxLength":8,"type":"string"}},"required":["event","description"],"type":"object"},"LoginData":{"description":"Get Access Token","properties":{"password":{"description":"Password","type":"string"},"username":{"description":"User Name","type":"string"}},"required":["username","password"],"type":"object"},"Monitor":{"description":"Customer Monitor Information","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["api","bitbar","dejaclick","email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","perfecto","ping","postman-api","security-scan","selenium","serveragent","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout"],"type":"object"},"MonitorApiStep":{"description":"Monitor api step settings","properties":{"assertions":{"description":"Monitor Assertions","items":{"$ref":"#/definitions/MonitorAssertion"},"type":"array"},"head":{"$ref":"#/definitions/MonitorWebsiteHeadAPI"},"http_method":{"default":"GET","description":"Mode of request: GET/POST/HEAD/CUSTOM","enum":["GET","POST","HEAD","CUSTOM"],"type":"string"},"post":{"$ref":"#/definitions/MonitorWebsitePost"},"step_name":{"description":"Step Name","maxLength":255,"type":"string"},"step_number":{"description":"Step Number","type":"integer"},"url":{"description":"URL to test.","format":"http_or_https_uri","maxLength":65535,"type":"string"},"variables":{"description":"Monitor Variables","items":{"$ref":"#/definitions/MonitorVariable"},"type":"array"}},"required":["url","http_method","head","step_name"],"type":"object"},"MonitorAssertion":{"description":"Assertion","properties":{"comparison":{"description":"Assertion comparison.","enum":["equals","does not equal","less than or equal","contains","does not contain","count","exists","does not exist","regular expression includes","regular expression excludes"],"type":"string"},"property":{"description":"Assertion property.","maxLength":256,"type":"string"},"source":{"description":"Source of assertion.","enum":["Response","JSON Response","XML Response","Timeout","Status Code","Header"],"type":"string"},"value":{"default":1,"description":"Assertion value.","maxLength":256,"type":"string"}},"type":"object"},"MonitorBitBar":{"description":"Monitor BitBar settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"api_key":{"description":"API Key","type":"string"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"device_group_id":{"description":"Device Group Id","readOnly":true,"type":"integer"},"device_group_name":{"description":"Device Group Name","readOnly":true,"type":"string"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"framework_id":{"description":"Framework Id","readOnly":true,"type":"integer"},"framework_name":{"description":"Framework Name","readOnly":true,"type":"string"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"hostname":{"default":"cloud.bitbar.com","description":"Hostname of BitBar server","type":"string"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":30,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"readOnly":true,"type":"array"},"mode":{"default":"One Handset (Rotated)","description":"Collection/notification mode.","enum":["One Handset (Rotated)","All Handsets Simultaneously"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"readOnly":true,"type":"integer"},"monitor_offset":{"description":"Monitor offset","maximum":120,"minimum":1,"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"project_id":{"description":"Project Id","readOnly":true,"type":"integer"},"project_name":{"description":"Project Name","readOnly":true,"type":"string"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"run_configuration":{"description":"Run Configuration","type":"string"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"type":{"description":"String representing monitor type.","enum":["api","bitbar","dejaclick","email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","perfecto","ping","postman-api","security-scan","selenium","serveragent","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","notify_on_error","home_location","allow_internal_testing","hostname","api_key","run_configuration"],"type":"object"},"MonitorBulkEdit":{"description":"Monitor settings","properties":{"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitors":{"description":"Monitor ids.","items":{"description":"Monitor id.","type":"integer"},"type":"array"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"update_locations_action":{"default":"replace","description":"Append or Replace Existing Locations","enum":["append","replace"],"type":"string"}},"required":["monitors","billing_plancode","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout"],"type":"object"},"MonitorBulkEditPassword":{"description":"Monitor passwords","properties":{"current_value":{"description":"Current value","maxLength":255,"type":"string"},"monitors":{"description":"Monitor ids.","items":{"description":"Monitor id.","type":"integer"},"type":"array"},"new_value":{"description":"New value","maxLength":255,"type":"string"}},"required":["monitors","current_value","new_value"],"type":"object"},"MonitorBulkEditScript":{"description":"Monitor values","properties":{"current_value":{"description":"Current value","type":"string"},"monitors":{"description":"Monitor ids.","items":{"description":"Monitor id.","type":"integer"},"type":"array"},"new_value":{"description":"New value","type":"string"}},"required":["monitors","current_value","new_value"],"type":"object"},"MonitorCapture":{"description":"Collect screenshots, headers, responses on error/actions/events.","properties":{"headers":{"default":true,"description":"Boolean indicating capture of HTTP headers.","type":"boolean"},"images":{"default":true,"description":"Boolean indicating capture of screenshot.","type":"boolean"},"level":{"default":"Error Only","description":"String indicating when captures occur.","enum":["Disabled","Error Only","All Actions on Error","All Actions","All Events on Error","All Events"],"type":"string"},"mimetype":{"default":"image/jpeg","description":"Mime-type of screenshot image.","enum":["image/jpeg","image/png"],"type":"string"},"sources":{"default":true,"description":"Boolean indicating capture of HTTP source.","type":"boolean"}},"required":["level","mimetype","headers","images","sources"],"type":"object"},"MonitorClone":{"description":"Clone a Monitor","properties":{"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"}},"type":"object"},"MonitorContentView":{"description":"Monitor Content View settings","properties":{"id":{"description":"Integer representing ContentView id.","type":"integer"},"inherit_global_errors":{"description":"Inherit errors from main script.","type":"boolean"},"name":{"description":"ContentView name","maxLength":80,"type":"string"},"notify_on_error":{"description":"Enable/disable notification triggers.","type":"boolean"}},"required":["id","notify_on_error","inherit_global_errors"],"type":"object"},"MonitorCustomProperty":{"description":"Custom Property","properties":{"id":{"description":"Propery Id.","type":"integer"},"name":{"description":"Propery Name","readOnly":true,"type":"string"},"value":{"description":"Property Value","readOnly":true,"type":"string"},"value_id":{"description":"Value Id.","type":"integer"}},"required":["id","value_id"],"type":"object"},"MonitorDNS":{"description":"Monitor DNS settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"hostname":{"description":"Hostname of nameserver.","type":"string"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"ipv4":{"description":"IP address to send request to.","format":"ipv4","type":"string"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"name_to_resolve":{"description":"Hostname to resolve","type":"string"},"name_to_resolve_id":{"default":0,"description":"Monitor id of Hostname to resolve ( 0 = www.yahoo.com )","type":"integer"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"port":{"description":"TCP port to send request to.","maximum":65535,"minimum":1,"type":"integer"},"resolve_dns":{"default":true,"description":"Resolve ip address of nameserver on each test.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout","hostname","name_to_resolve_id"],"type":"object"},"MonitorDejaClick":{"description":"Customer Monitor Information","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"browser_type":{"default":"Firefox","description":"String representing browser type.","enum":["Google Chrome","Internet Explorer","Firefox"],"readOnly":true,"type":"string"},"capture":{"$ref":"#/definitions/MonitorCapture"},"check_fullpage_missing_objects":{"description":"Change in returned object set triggers notification.","type":"boolean"},"check_fullpage_object_sizes":{"description":"Change in object sizes trigger notification.","type":"boolean"},"content_views":{"description":"Content Views of monitor.","items":{"$ref":"#/definitions/MonitorContentView"},"type":"array"},"continue_playback_on_timeout":{"default":false,"description":"Trigger notification on changes in page objects.","type":"boolean"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"fullpage_object_timeout":{"default":10,"description":"Seconds before halting incomplete fullpage collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_capture":{"description":"Monitor has capture enabled.","readOnly":true,"type":"boolean"},"has_content_views":{"description":"Script contains content views.","readOnly":true,"type":"boolean"},"has_mobile_locations":{"description":"Monitor has mobile locations enabled.","readOnly":true,"type":"boolean"},"has_multipop":{"description":"Monitor is monitoring in multipop mode.","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"has_user_experience":{"description":"Monitor has user experience measurements enabled.","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"interval_fullpage":{"default":-1,"description":"Minutes between fullpage collection attempts.","enum":[-1,1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"ipv6_enabled":{"default":"Disabled","description":"Replay transaction over IPv6.","enum":["Disabled","Preferred","Enforced"],"type":"string"},"is_content_view":{"description":"Monitor is a content view.","readOnly":true,"type":"boolean"},"is_transaction":{"description":"Indicates monitor is a multi-step collection.","readOnly":true,"type":"boolean"},"keyword_action":{"default":"Generate an error","description":"Action to perform when the keyword match is found or not.","enum":["Generate an error","Continue waiting"],"type":"string"},"keyword_allow_line_wrap":{"default":true,"description":"Match even the values with line breaks.","type":"boolean"},"keyword_match_case":{"default":true,"description":"Consider the characters case during the validation","type":"boolean"},"keyword_match_invert":{"default":false,"description":"Consider keyword match failure/success.","type":"boolean"},"keyword_match_type":{"default":"Plain Text","description":"Treat keyword as text or regular expresion.","enum":["Plain Text","Regular Expression"],"type":"string"},"keyword_match_whole_word":{"default":true,"description":"Match the whole word or phrase only.","type":"boolean"},"keyword_normalize_spaces":{"default":true,"description":"Normalize blank spaces during the validation.","type":"boolean"},"keyword_string":{"default":"","description":"Pattern to check for in response.","maxLength":255,"type":"string"},"last_modified":{"description":"Timestamp of last configuration edit.","format":"date-time","readOnly":true,"type":"string"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mobile_location_count":{"description":"Count of mobile locations enabled.","readOnly":true,"type":"integer"},"mobile_type":{"description":"Indicates emulated mobile type. (Android, iPhone, etc.)","readOnly":true,"type":"string"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_agent":{"description":"Monitoring playback software","enum":[""],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_content_change":{"default":false,"description":"Trigger notification on content change. (last step only)","type":"boolean"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"notify_on_fullpage_errors":{"description":"Page objects errors trigger notification.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"script":{"description":"Collection driver script.","format":"xml","type":"string"},"script_created":{"description":"Script created data.","readOnly":true,"type":"string"},"script_modified":{"description":"Script modified data.","readOnly":true,"type":"string"},"script_modified_by_user":{"description":"Script modified by user data.","readOnly":true,"type":"string"},"script_replayed_successfully":{"description":"Transaction has been validated by Test On Demand.","readOnly":true,"type":"boolean"},"script_status":{"description":"String representing last script playback state.","readOnly":true,"type":"string"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"ssl_cert_format":{"description":"SSL Certificate format.","readOnly":true,"type":"string"},"ssl_cert_id":{"description":"SSL Certificate id.","type":"integer"},"ssl_cert_name":{"description":"SSL Certificate name.","readOnly":true,"type":"string"},"step_timeout":{"description":"Browser Timeout seconds.","maximum":300,"minimum":0,"type":"integer"},"subtype":{"description":"Subtype Application id","enum":[0,1,2,3],"type":"integer"},"subtype_application":{"description":"Subtype Application","type":"string"},"subtype_name":{"description":"Subtype Name","type":"string"},"third_party_document_errors":{"default":false,"description":"Enable Third-Party Document Errors.","type":"boolean"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"transaction_events":{"description":"Count of transaction events in monitor.","readOnly":true,"type":"integer"},"transaction_password":{"description":"Password to unlock protected script variables.","type":"string"},"transaction_steps":{"description":"Count of transaction steps in monitor.","maximum":50,"minimum":1,"readOnly":true,"type":"integer"},"transaction_steps_allowed":{"description":"Administrative override of maxiumum transaction steps allowed.","type":"integer"},"transaction_trace":{"default":false,"description":"Enable Transaction Tracing","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["dejaclick"],"type":"string"},"url":{"description":"URL to test.","maxLength":65535,"type":"string"},"use_client_ssl_cert":{"default":false,"description":"Use user-supplied client certificate when connecting.","type":"boolean"},"user_experience_base_page_only":{"description":"Only use root-page user-experience measurements.","type":"boolean"},"user_experience_enabled":{"description":"Enable user-experience measurement collection.","type":"boolean"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout","interval_fullpage","continue_playback_on_timeout"],"type":"object"},"MonitorEmailIMAP":{"description":"Monitor Email IMAP settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"hostname":{"description":"Hostname of IMAP server.","type":"string"},"id":{"description":"Integer representing monitor id.","type":"integer"},"imap_password":{"description":"IMAP auth credentials - password","maxLength":255,"type":"string"},"imap_username":{"description":"IMAP credentials - username","maxLength":255,"type":"string"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"ipv4":{"description":"IP address to send request to.","format":"ipv4","type":"string"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"port":{"description":"TCP port to send request to.","maximum":65535,"minimum":1,"type":"integer"},"resolve_dns":{"default":true,"description":"Resolve ip address of IMAP server on each test.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout","hostname"],"type":"object"},"MonitorEmailPOP":{"description":"Monitor Email POP settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"hostname":{"description":"Hostname of POP server.","type":"string"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"ipv4":{"description":"IP address to send request to.","format":"ipv4","type":"string"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"pop_password":{"description":"POP auth credentials - password","maxLength":255,"type":"string"},"pop_username":{"description":"POP credentials - username","maxLength":255,"type":"string"},"port":{"description":"TCP port to send request to.","maximum":65535,"minimum":1,"type":"integer"},"resolve_dns":{"default":true,"description":"Resolve ip address of POP server on each test.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout","hostname"],"type":"object"},"MonitorEmailRoundtrip":{"description":"Monitor Email Round Trip settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"email":{"description":"Email address to send to/pop from.","type":"string"},"email_password":{"description":"Email credentials - password","maxLength":255,"type":"string"},"email_username":{"description":"Email credentials - username","maxLength":255,"type":"string"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"pop3_hostname":{"description":"Hostname of POP3 server.","type":"string"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"smtp_hostname":{"description":"Hostname of SMTP server.","type":"string"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout","smtp_hostname","pop3_hostname","email"],"type":"object"},"MonitorEmailSMTP":{"description":"Monitor Email SMTP settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"hostname":{"description":"Hostname of SMTP server.","type":"string"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"ipv4":{"description":"IP address to send request to.","format":"ipv4","type":"string"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"port":{"description":"TCP port to send request to.","maximum":65535,"minimum":1,"type":"integer"},"resolve_dns":{"default":true,"description":"Resolve ip address of SMTP server on each test.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"smtp_password":{"description":"SMTP auth credentials - password","maxLength":255,"type":"string"},"smtp_username":{"description":"SMTP credentials - username","maxLength":255,"type":"string"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout","hostname"],"type":"object"},"MonitorFTP":{"description":"Monitor FTP settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enable_ftp_upload":{"description":"Attempt file upload to FTP server.","type":"boolean"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"ftp_password":{"description":"FTP password to use when connecting.","type":"string"},"ftp_username":{"description":"FTP username to use when connecting.","type":"string"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"hostname":{"description":"Hostname of FTP server.","type":"string"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"ipv4":{"description":"IP address to send request to.","format":"ipv4","type":"string"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"port":{"description":"TCP port to send request to.","maximum":65535,"minimum":1,"type":"integer"},"resolve_dns":{"default":true,"description":"Resolve ip address of nameserver on each test.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout","hostname","enable_ftp_upload"],"type":"object"},"MonitorFTPS":{"description":"Monitor FTPS settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enable_ftp_upload":{"description":"Attempt file upload to FTP server.","type":"boolean"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"ftp_password":{"description":"FTP password to use when connecting.","type":"string"},"ftp_username":{"description":"FTP username to use when connecting.","type":"string"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"hostname":{"description":"Hostname of FTP server.","type":"string"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"ipv4":{"description":"IP address to send request to.","format":"ipv4","type":"string"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"port":{"description":"TCP port to send request to.","maximum":65535,"minimum":1,"type":"integer"},"resolve_dns":{"default":true,"description":"Resolve ip address of nameserver on each test.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"ssl_cert_format":{"description":"SSL Certificate format.","readOnly":true,"type":"string"},"ssl_cert_id":{"description":"SSL Certificate id.","type":"integer"},"ssl_cert_name":{"description":"SSL Certificate name.","readOnly":true,"type":"string"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"},"use_client_ssl_cert":{"default":false,"description":"Use user-supplied client certificate when connecting.","type":"boolean"},"use_ssl_version":{"default":"","description":"Version of SSL protocol to use when connecting.","enum":["","2","3","10","11","12"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout","hostname","enable_ftp_upload"],"type":"object"},"MonitorLocations":{"description":"Location","properties":{"id":{"description":"Location Id","type":"integer"},"name":{"description":"Location Name","maxLength":255,"type":"string"},"region":{"description":"Region code for location","type":"integer"}},"required":["id","name"],"type":"object"},"MonitorPerfecto":{"description":"Monitor Perfecto settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":30,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"One Handset (Rotated)","description":"Collection/notification mode.","enum":["One Handset (Rotated)","All Handsets Simultaneously"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"readOnly":true,"type":"integer"},"monitor_offset":{"description":"Monitor offset","maximum":120,"minimum":1,"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"perfecto_hostname":{"default":"www.perfectomobile.com","description":"Hostname of Perfecto server.","type":"string"},"perfecto_password":{"description":"Password to use when connecting.","type":"string"},"perfecto_script_name":{"description":"Perfecto script","readOnly":true,"type":"string"},"perfecto_script_value":{"description":"Perfecto script value","type":"string"},"perfecto_username":{"description":"Username to use when connecting.","type":"string"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"type":{"description":"String representing monitor type.","enum":["perfecto"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","notify_on_error","home_location","allow_internal_testing","perfecto_hostname","perfecto_username","perfecto_password"],"type":"object"},"MonitorPing":{"description":"Monitor Ping settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"hostname":{"description":"Hostname.","type":"string"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"ipv4":{"description":"IP address to connect to.","format":"ipv4","type":"string"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"port":{"description":"port to ping.","maximum":65535,"minimum":1,"type":"integer"},"resolve_dns":{"default":true,"description":"Resolve ip address of hostname from url on each test.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout","hostname"],"type":"object"},"MonitorPostman":{"description":"Monitor Postman settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"capture":{"$ref":"#/definitions/MonitorCapture"},"collection_name":{"description":"Name of uploaded Postman Collection.","readOnly":true,"type":"string"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"folder":{"description":"Selected Postman Collection folder.","type":"string"},"folder_path":{"description":"Selected Postman Collection folder path.","type":"string"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"is_transaction":{"description":"Indicates monitor is a multi-step collection.","readOnly":true,"type":"boolean"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_agent":{"description":"Monitoring playback software","enum":["Newman 5.3"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"replay_success":{"default":false,"description":"Transaction has been validated by Test On Demand.","readOnly":true,"type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"script":{"description":"JSON of Postman Collection.","type":"string"},"script_id":{"description":"Id of uploaded script","type":"string"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"ssl_cert_format":{"description":"SSL Certificate format.","readOnly":true,"type":"string"},"ssl_cert_id":{"description":"SSL Certificate id.","type":"integer"},"ssl_cert_name":{"description":"SSL Certificate name.","readOnly":true,"type":"string"},"subtype":{"description":"Subtype Application id","enum":[0,4],"type":"integer"},"subtype_application":{"description":"Subtype Application","type":"string"},"subtype_name":{"description":"Subtype Name","type":"string"},"transaction_steps":{"description":"Count of transaction steps in monitor.","maximum":50,"minimum":1,"type":"integer"},"transaction_steps_allowed":{"description":"Administrative override of maxiumum transaction steps allowed.","type":"integer"},"transaction_trace":{"default":false,"description":"Enable Transaction Tracing","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["postman-api"],"type":"string"},"use_client_ssl_cert":{"default":false,"description":"Use user-supplied client certificate when connecting.","type":"boolean"},"use_ssl_version":{"default":"","description":"Version of SSL protocol to use when connecting.","enum":["","2","3","10","11","12"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","folder"],"type":"object"},"MonitorSOAPAPI":{"description":"Monitor SOAPAPI settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"capture":{"$ref":"#/definitions/MonitorCapture"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"is_transaction":{"description":"Indicates monitor is a multi-step collection.","readOnly":true,"type":"boolean"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_agent":{"description":"Monitoring playback software","enum":["ReadyAPI 1.9","ReadyAPI 3.59","TestEngine","TestEngine 1.7","TestEngine 1.23","TestEngine 1.27","TestEngine 1.33"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"project_name":{"description":"Name of uploaded SoapUI project.","readOnly":true,"type":"string"},"project_password":{"description":"Project password used to decrypt project file.","type":"string"},"replay_success":{"default":false,"description":"Transaction has been validated by Test On Demand.","readOnly":true,"type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"script":{"description":"XML of SoapUI project.","type":"string"},"script_id":{"description":"Id of uploaded script","type":"string"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"ssl_cert_format":{"description":"SSL Certificate format.","readOnly":true,"type":"string"},"ssl_cert_id":{"description":"SSL Certificate id.","type":"integer"},"ssl_cert_name":{"description":"SSL Certificate name.","readOnly":true,"type":"string"},"subtype":{"description":"Subtype Application id","enum":[0,4],"type":"integer"},"subtype_application":{"description":"Subtype Application","type":"string"},"subtype_name":{"description":"Subtype Name","type":"string"},"test_case":{"description":"Selected SoapUI project TestCase.","type":"string"},"test_suite":{"description":"Selected SoapUI project TestSuite.","type":"string"},"transaction_steps":{"description":"Count of transaction steps in monitor.","maximum":50,"minimum":1,"type":"integer"},"transaction_steps_allowed":{"description":"Administrative override of maxiumum transaction steps allowed.","type":"integer"},"transaction_trace":{"default":false,"description":"Enable Transaction Tracing","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["api"],"type":"string"},"use_client_ssl_cert":{"default":false,"description":"Use user-supplied client certificate when connecting.","type":"boolean"},"use_ssl_version":{"default":"","description":"Version of SSL protocol to use when connecting.","enum":["","2","3","10","11","12"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","test_suite","test_case"],"type":"object"},"MonitorSecurity":{"description":"Monitor Security settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"exclusions":{"description":"Vulnerability exclusions","items":{"$ref":"#/definitions/MonitorSecurityExclusion"},"type":"array"},"id":{"description":"Integer representing monitor id.","type":"integer"},"ipv4":{"description":"IP address of scan target.","format":"ipv4","type":"string"},"last_scanned":{"description":"String indicating time of last security-scan.","format":"date-time","readOnly":true,"type":"string"},"last_status":{"description":"String indicating security-scan result status.","readOnly":true,"type":"string"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"scan_day":{"description":"String indicating day of week to run security-scan.","enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"scan_enabled":{"description":"Boolean indicating security monitor is enabled.","type":"boolean"},"scan_frequency":{"description":"String indicating frequency of security scan.","enum":["Daily","Weekly","Monthly"],"type":"string"},"scan_hostname":{"description":"Hostname of security scan target.","format":"hostname","type":"string"},"scan_hour":{"description":"Integer indicating hour of day scan is scheduled.","maximum":23,"minimum":0,"type":"integer"},"scan_suite":{"description":"String indicating security-scan settings to use.","enum":["standard","local network"],"type":"string"},"type":{"description":"String representing monitor type.","enum":["security-scan"],"type":"string"}},"required":["id","type","billing_plancode","name","notify_on_error","scan_hostname","scan_enabled","scan_frequency","scan_hour","scan_suite"],"type":"object"},"MonitorSecurityExclusion":{"description":"Security Monitor Exclusion","properties":{"enabled":{"description":"String indicating exclusion is applied to vulnerability score.","type":"boolean"},"id":{"description":"Id of security monitor","type":"integer"},"message":{"description":"Full description of detected vulnerability.","readOnly":true,"type":"string"},"message_id":{"description":"ID of full description.","readOnly":true,"type":"integer"},"score":{"description":"Integer representing vulnerability risk. 7 == informational, 1 == critical.","maximum":7,"minimum":1,"readOnly":true,"type":"integer"},"script_id":{"description":"ID of security scanner plugin.","type":"integer"},"service":{"description":"String indicating tcp port and service.","type":"string"},"short_message":{"description":"Short description of detected vulnerability.","readOnly":true,"type":"string"},"short_message_id":{"description":"ID of short description.","readOnly":true,"type":"integer"}},"required":["id","service","enabled","script_id"],"type":"object"},"MonitorSelenium":{"description":"Monitor Selenium settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"capture":{"$ref":"#/definitions/MonitorCapture"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"fullpage_object_timeout":{"default":10,"description":"Seconds before halting incomplete fullpage collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"is_transaction":{"description":"Indicates monitor is a multi-step collection.","readOnly":true,"type":"boolean"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_agent":{"description":"Monitoring playback software","enum":["Chrome Driver 74","Chrome Driver 85","Chrome Driver 120"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"replay_success":{"default":false,"description":"Transaction has been validated by Test On Demand.","readOnly":true,"type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"script":{"description":"Encoded jar selenium script.","type":"string"},"script_id":{"description":"Id of uploaded script","type":"string"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"step_timeout":{"description":"Seconds before halting step in transaction.","maximum":300,"minimum":0,"type":"integer"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"transaction_steps_allowed":{"description":"Administrative override of maxiumum transaction steps allowed.","type":"integer"},"type":{"description":"String representing monitor type.","enum":["selenium"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","timeout"],"type":"object"},"MonitorServerAgent":{"description":"Monitor ServerAgent settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["serveragent"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","notify_on_error","home_location"],"type":"object"},"MonitorTCP":{"description":"Monitor TCP settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"hostname":{"description":"Hostname to connect.","type":"string"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"ipv4":{"description":"IP address to connect to.","format":"ipv4","type":"string"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"port":{"description":"TCP port to connect to.","maximum":65535,"minimum":1,"type":"integer"},"resolve_dns":{"default":true,"description":"Resolve ip address of hostname from url on each test.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout","hostname","port"],"type":"object"},"MonitorVariable":{"description":"Variable","properties":{"name":{"description":"Variable name","format":"variable_name","maxLength":32,"type":"string"},"property":{"description":"Variable property","maxLength":256,"type":"string"}},"required":["name","property"],"type":"object"},"MonitorWebsite":{"description":"Monitor Website settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"get":{"$ref":"#/definitions/MonitorWebsiteGet"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"head":{"$ref":"#/definitions/MonitorWebsiteHead"},"home_location":{"description":"Location id of primary location.","type":"integer"},"http_method":{"default":"GET","description":"Mode of request: GET/POST/HEAD/CUSTOM","enum":["GET","POST","HEAD","CUSTOM"],"type":"string"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_content_change":{"default":false,"description":"Trigger notification on content change. (last step only)","type":"boolean"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"post":{"$ref":"#/definitions/MonitorWebsitePost"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"transaction_trace":{"default":false,"description":"Enable Transaction Tracing","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"},"url":{"description":"URL to test.","maxLength":65535,"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout","url","http_method","head"],"type":"object"},"MonitorWebsiteAPI":{"description":"Monitor Website API settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"api_steps":{"description":"Monitor api_steps","items":{"$ref":"#/definitions/MonitorApiStep"},"type":"array"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"capture":{"$ref":"#/definitions/MonitorCapture"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"get":{"$ref":"#/definitions/MonitorWebsiteGetAPI"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"local_validation":{"default":false,"description":"Monitor requires local validation.","type":"boolean"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_agent":{"description":"Monitoring playback software","enum":["ReadyAPI 1.9","ReadyAPI 3.59","TestEngine","TestEngine 1.7","TestEngine 1.23","TestEngine 1.27","TestEngine 1.33"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"transaction_steps":{"description":"Count of transaction steps in monitor.","maximum":50,"minimum":1,"type":"integer"},"transaction_steps_allowed":{"description":"Administrative override of maxiumum transaction steps allowed.","type":"integer"},"transaction_trace":{"default":false,"description":"Enable Transaction Tracing","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","timeout","api_steps"],"type":"object"},"MonitorWebsiteGet":{"description":"HTTP Get Parameters","properties":{"check_fullpage_missing_objects":{"default":false,"description":"Change in returned object set triggers notification.","type":"boolean"},"check_fullpage_object_sizes":{"default":false,"description":"Change in object sizes trigger notification.","type":"boolean"},"fullpage_object_timeout":{"default":10,"description":"Seconds before halting incomplete fullpage collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"http_302_is_error":{"default":false,"description":"Consider redirect responses an error condition","type":"boolean"},"http_401_is_error":{"default":false,"description":"Consider auth-challenge responses an error condition.","type":"boolean"},"http_caching":{"default":false,"description":"Cache fullpage objects.","type":"boolean"},"http_compression":{"default":false,"description":"Use gzip compressed HTTP request.","type":"boolean"},"interval_fullpage":{"default":-1,"description":"Minutes between fullpage collection attempts.","enum":[-1,1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"keyword_match_invert":{"default":false,"description":"Consider keyword match failure/success.","type":"boolean"},"keyword_match_type":{"default":"Plain Text","description":"Treat keyword as text or regular expresion.","enum":["Plain Text","Regular Expression"],"type":"string"},"keyword_string":{"default":"","description":"Pattern to check for in response.","maxLength":255,"type":"string"},"notify_on_fullpage_errors":{"default":false,"description":"Page object errors trigger notification.","type":"boolean"}},"required":["http_compression","http_caching","http_302_is_error","http_401_is_error","keyword_match_invert"],"type":"object"},"MonitorWebsiteGetAPI":{"description":"HTTP Get Parameters","properties":{"http_302_is_error":{"default":false,"description":"Consider redirect responses an error condition","type":"boolean"},"http_401_is_error":{"default":false,"description":"Consider auth-challenge responses an error condition.","type":"boolean"},"interval_fullpage":{"default":-1,"description":"Minutes between fullpage collection attempts.","enum":[-1],"type":"integer"}},"required":["http_302_is_error","http_401_is_error"],"type":"object"},"MonitorWebsiteHead":{"description":"HTTP Head Parameters","properties":{"http_basic_auth_password":{"description":"HTTP Basic-auth credentials - password","maxLength":255,"type":"string"},"http_basic_auth_username":{"description":"HTTP Basic-auth credentials - username","maxLength":255,"type":"string"},"http_follow_redirects":{"default":true,"description":"Follow HTTP 301/302 url if encountered.","type":"boolean"},"http_user_agent":{"default":"Alertsite 1 -- ipd/1.0 (ipd; IPD 1.0; AlertSite)","description":"UserAgent string to use in HTTP request.","enum":["Alertsite 1 -- ipd/1.0 (ipd; IPD 1.0; AlertSite)","Firefox 1 -- Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.7.12) Gecko/20050915 Firefox/1.0.7 (AlertSite)","Firefox 2 -- Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.18) Gecko/20081029 Firefox/2.0.0.18 (AlertSite)","Firefox 3 -- Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.4) Gecko/2008102920 Firefox/3.0.4 (AlertSite)","Firefox 29 -- Mozilla/5.0 (Windows NT 6.1; WOW64; rv:29.0) Gecko/20100101 Firefox/29.0 (AlertSite)","Google Chrome 0.4 -- Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/525.19 (KHTML, like Gecko) Chrome/0.4.154.29 Safari/525.19","Google Chrome 34 -- Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.137 Safari/537.36 (AlertSite)","IE 5 -- Mozilla/4.5 (compatible; MSIE 5.01; Windows NT 5.0; AlertSite)","IE 5.5 -- Mozilla/4.0 (compatible; MSIE 5.5; Windows NT 5.0; .NET CLR 1.0.3705; AlertSite)","IE 6 -- Mozilla/4.5 (compatible; MSIE 6.00; Windows NT 5.0; AlertSite)","IE 6 -- Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0; .NET CLR 1.0.3705; .NET CLR 1.1.4322; AlertSite)","IE 7 -- Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727) MSIE/7 (AlertSite)","IE 9 -- Mozilla/5.0 (Windows; U; MSIE 9.0; Windows NT 9.0; en-US) (AlertSite)","IE 10 -- Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.1; Trident/6.0) (AlertSite)","iPhone 2.2 -- Mozilla/5.0 (iPhone; U; CPU iPhone OS 2_2 like Mac OS X; en-us) AppleWebKit/525.18.1 (KHTML, like Gecko; AlertSite)","iPhone 7 -- Mozilla/5.0 (iPhone; CPU iPhone OS 711 like Mac OS X) AppleWebKit/537.51.2 (KHTML like Gecko) Version/7.0 Mobile/11D201 Safari/9537.53 (AlertSite)","Opera 9 -- Opera/9.62 (Windows NT 5.1; U; en) Presto/2.1.1 (AlertSite)","Opera 19 -- Mozilla/5.0 (Windows NT 6.3) AppleWebKit/537.36 (KHTML like Gecko) Chrome/32.0.1700.107 Safari/537.36 OPR/19.0.1326.63 (AlertSite)"],"type":"string"},"http_version":{"default":"1.0","description":"Version number of HTTP to use in HTTP header.","enum":["1.0","1.1"],"type":"string"},"ipv4":{"description":"IPv4 address to send request to (overridden if resolve dns is enabled).","format":"ipv4","type":"string"},"port":{"description":"Port to send request to","maximum":65535,"minimum":1,"type":"integer"},"resolve_dns":{"default":true,"description":"Resolve ip address of hostname from url on each test.","type":"boolean"}},"required":["http_version","http_user_agent"],"type":"object"},"MonitorWebsiteHeadAPI":{"description":"HTTP Head Parameters","properties":{"http_basic_auth_password":{"description":"HTTP Basic-auth credentials - password","maxLength":255,"type":"string"},"http_basic_auth_username":{"description":"HTTP Basic-auth credentials - username","maxLength":255,"type":"string"},"preemptive_authentication":{"default":false,"description":"Authenticate pre-emptively","type":"boolean"}},"type":"object"},"MonitorWebsitePost":{"description":"HTTP Post Parameters","properties":{"http_header_use_custom":{"default":false,"description":"Send HTTP Headers exactly as entered. (experts only!)","type":"boolean"},"http_post_data_key_value_pairs":{"description":"POST payload content","maxLength":65535,"type":"string"},"http_post_data_raw":{"default":false,"description":"Send user-supplied payload exactly as entered.","type":"boolean"}},"type":"object"},"MonitorWebsiteSSL":{"description":"Monitor - Secure Website","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"check_ssl_expiration_dates":{"default":"Disabled","description":"Notify when cert-chain expires in 1,2,7,15, or 30 days.","enum":["Disabled","Expired","1 Day","2 Days","7 Days","15 Days","30 Days","60 Days"],"type":"string"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"get":{"$ref":"#/definitions/MonitorWebsiteGet"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"head":{"$ref":"#/definitions/MonitorWebsiteHead"},"home_location":{"description":"Location id of primary location.","type":"integer"},"http_method":{"default":"GET","description":"Mode of request: GET/POST/HEAD/CUSTOM","enum":["GET","POST","HEAD","CUSTOM"],"type":"string"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_content_change":{"default":false,"description":"Trigger notification on content change. (last step only)","type":"boolean"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"post":{"$ref":"#/definitions/MonitorWebsitePost"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"ssl_cert_format":{"description":"SSL Certificate format.","readOnly":true,"type":"string"},"ssl_cert_id":{"description":"SSL Certificate id.","type":"integer"},"ssl_cert_name":{"description":"SSL Certificate name.","readOnly":true,"type":"string"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"traceroute_on_error":{"default":true,"description":"Perform traceroute after error condition.","type":"boolean"},"transaction_trace":{"default":false,"description":"Enable Transaction Tracing","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"},"url":{"description":"URL to test.","maxLength":65535,"type":"string"},"use_client_ssl_cert":{"default":false,"description":"Use user-supplied client certificate when connecting.","type":"boolean"},"use_ssl_options":{"default":"","description":"Options of SSL to use when connecting","enum":["","OP_LEGACY_SERVER_CONNECT"],"type":"string"},"use_ssl_version":{"default":"","description":"Version of SSL protocol to use when connecting.","enum":["","2","3","10","11","12"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","traceroute_on_error","timeout","url","http_method","head","check_ssl_expiration_dates"],"type":"object"},"MonitorWebsiteSSLAPI":{"description":"Monitor Website Secure API settings","properties":{"access_type":{"default":"View","description":"Access Type","enum":["View","Edit"],"readOnly":true,"type":"string"},"alert_note":{"description":"Alert Note","maxLength":1000,"type":"string"},"allow_internal_testing":{"default":true,"description":"Allow alertsite to perform out-of-schedule tests.","type":"boolean"},"api_steps":{"description":"Monitor api_steps","items":{"$ref":"#/definitions/MonitorApiStep"},"type":"array"},"billing_plancode":{"description":"String representing billing plan.","type":"string"},"blackout_ids":{"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"capture":{"$ref":"#/definitions/MonitorCapture"},"custom_properties":{"description":"Custom Properties for monitor.","items":{"$ref":"#/definitions/MonitorCustomProperty"},"type":"array"},"customer_id":{"description":"Integer representing customer id.","readOnly":true,"type":"integer"},"enabled":{"default":true,"description":"Enable/disable monitoring/collection","type":"boolean"},"get":{"$ref":"#/definitions/MonitorWebsiteGetAPI"},"has_active_performance_alerts":{"description":"Monitor has Active Performance Alerts","readOnly":true,"type":"boolean"},"has_performance_alerts":{"description":"Monitor has Performance Alerts","readOnly":true,"type":"boolean"},"has_sla":{"description":"Monitor has SLA","readOnly":true,"type":"boolean"},"home_location":{"description":"Location id of primary location.","type":"integer"},"id":{"description":"Integer representing monitor id.","type":"integer"},"interval":{"default":5,"description":"Minutes between collection attempts.","enum":[1,2,3,4,5,6,10,15,20,30,60,120],"type":"integer"},"local_validation":{"default":false,"description":"Monitor requires local validation.","type":"boolean"},"locations":{"description":"Location ids of assigned locations.","items":{"$ref":"#/definitions/MonitorLocations"},"type":"array"},"mode":{"default":"Global Verify","description":"Collection/notification mode.","enum":["Primary","Global Notify","Global Verify","Round Robin","SLA (MultiPOP)"],"type":"string"},"monitor_agent":{"description":"Monitoring playback software","enum":["ReadyAPI 1.9","ReadyAPI 3.59","TestEngine","TestEngine 1.7","TestEngine 1.23","TestEngine 1.27","TestEngine 1.33"],"type":"string"},"monitor_location_count":{"default":0,"description":"Number of locations invoked per collection interval. Behavior driven by \"mode\"","enum":[0],"type":"integer"},"monitor_uses_own_locations":{"description":"Monitor has custom locations","readOnly":true,"type":"boolean"},"name":{"description":"User-defined label for monitor.","maxLength":255,"type":"string"},"note":{"description":"Monitor Note","maxLength":1000,"type":"string"},"notify_on_error":{"default":true,"description":"Enable/disable notification triggers.","type":"boolean"},"retry_on_failure":{"default":true,"description":"Enable/disable second attempt on failure.","type":"boolean"},"rotate_locations":{"default":false,"description":"Enables rotation through configured locations. Driven by monitor_location_count.","type":"boolean"},"sla_id":{"description":"ID of Service Level Agreement configuration.","readOnly":true,"type":"integer"},"ssl_cert_format":{"description":"SSL Certificate format.","readOnly":true,"type":"string"},"ssl_cert_id":{"description":"SSL Certificate id.","type":"integer"},"ssl_cert_name":{"description":"SSL Certificate name.","readOnly":true,"type":"string"},"timeout":{"default":30,"description":"Seconds before halting incomplete collection.","enum":[1,2,3,4,5,6,7,8,9,10,15,20,25,30,45,60,75,90,120,150,180,240,300],"type":"integer"},"transaction_steps":{"description":"Count of transaction steps in monitor.","maximum":50,"minimum":1,"type":"integer"},"transaction_steps_allowed":{"description":"Administrative override of maxiumum transaction steps allowed.","type":"integer"},"transaction_trace":{"default":false,"description":"Enable Transaction Tracing","type":"boolean"},"type":{"description":"String representing monitor type.","enum":["email-imap","email-pop","email-round-trip","email-smtp","ftp","ftp-ssl","name-server","ping","tcp","website","website-api","website-ssl","website-ssl-api"],"type":"string"},"use_client_ssl_cert":{"default":false,"description":"Use user-supplied client certificate when connecting.","type":"boolean"},"use_ssl_version":{"default":"","description":"Version of SSL protocol to use when connecting.","enum":["","2","3","10","11","12"],"type":"string"}},"required":["id","type","billing_plancode","name","enabled","interval","mode","rotate_locations","monitor_location_count","notify_on_error","home_location","retry_on_failure","allow_internal_testing","timeout","api_steps"],"type":"object"},"NotifierGroup":{"description":"Notifier Group Information","properties":{"errortypes":{"description":"Error types","items":{"$ref":"#/definitions/NotifierGroupErrorType"},"type":"array"},"id":{"description":"Group id","type":"integer"},"is_default":{"default":false,"description":"Default Group will be used for all unassigned monitors","type":"boolean"},"monitors":{"description":"Ids of assigned monitors","items":{"$ref":"#/definitions/NotifierGroupMonitor"},"type":"array"},"name":{"description":"Group name","type":"string"},"recipients":{"description":"Ids of assigned recipients","items":{"$ref":"#/definitions/NotifierGroupRecipient"},"type":"array"},"templates":{"description":"Ids of assigned templates","items":{"$ref":"#/definitions/NotifierGroupTemplate"},"type":"array"}},"required":["id","name","monitors","recipients"],"type":"object"},"NotifierGroupErrorType":{"description":"Error Types","properties":{"description":{"description":"Description of error code.","readOnly":true,"type":"string"},"id":{"description":"Integer representing error code.","enum":[1,2,3,5,6,7,8,9,20,30,40,50,51,59,60,61,80,81,82,83,84,85,86,89,91,92,93,94,96,97,99,121,122,123,130,202,300,501,502,503,510,511,512,520,521,530,531,540,541,542,544,550,560,570,580,581,582,583,584,585,586,587,590,591],"type":"integer"}},"required":["id"],"type":"object"},"NotifierGroupMonitor":{"description":"Monitor","properties":{"id":{"description":"Integer representing monitor id.","type":"integer"},"name":{"description":"User-defined label for monitor.","readOnly":true,"type":"string"},"step_name":{"description":"Step name","readOnly":true,"type":"string"},"step_number":{"description":"Step number","type":"integer"}},"required":["id"],"type":"object"},"NotifierGroupRecipient":{"description":"Recipient","properties":{"id":{"description":"Recipient id","type":"integer"},"name":{"description":"Recipient description","readOnly":true,"type":"string"},"recipient":{"description":"Alert recipient","readOnly":true,"type":"string"}},"required":["id"],"type":"object"},"NotifierGroupTemplate":{"description":"Template","properties":{"alert_description_short":{"description":"Alert Description (short version)","readOnly":true,"type":"string"},"id":{"description":"Alert Template id","type":"integer"},"name":{"description":"Alert Template name","readOnly":true,"type":"string"}},"required":["id"],"type":"object"},"PerfAlert":{"description":"Performance Alert Information","properties":{"assoc_id":{"description":"Parent Monitor id for ContentView","type":"integer"},"current_window":{"description":"Current Window (minutes)","enum":[10,20,30,60,120,180,240,300,360,420,480,540,600,660,720,780,840,900,960,1020,1080,1140,1200,1260,1320,1380,1440],"type":"integer"},"dynamic_error":{"description":"Error percent change of response time","type":"number"},"dynamic_warning":{"description":"Warning percent change of response time","type":"number"},"enabled":{"description":"Enabled","type":"boolean"},"historic_window":{"description":"Historic Window (minutes)","enum":[1440,2880,4320,5760,7200,8640,10080],"type":"integer"},"id":{"description":"Monitor id","type":"integer"},"location_count":{"description":"Count of locations in error/warning before notification","type":"integer"},"location_percent":{"description":"Percent of locations in error/warning before notification","maximum":100,"minimum":0,"type":"number"},"metric":{"description":"Response time metric","enum":["resptime","resptime_fullpage","dejatime_firstpaint","dejatime_afttime","dejatime_domload","dejatime_pageload","resptime_dns","resptime_connect","resptime_firstbyte","resptime_content"],"type":"string"},"name":{"description":"Monitor name","readOnly":true,"type":"string"},"perf_alert_type":{"description":"Performance Alert Type","enum":["dynamic","static"],"type":"string"},"static_error":{"description":"Error value of response time","type":"number"},"static_warning":{"description":"Warning value of response time","type":"number"},"step_number":{"description":"Step Number","maximum":0,"minimum":0,"type":"integer"}},"required":["id","step_number","enabled","metric","perf_alert_type","current_window"],"type":"object"},"Property":{"description":"Custom Propert infomation","properties":{"id":{"description":"Property id","type":"integer"},"name":{"description":"Property name","maxLength":255,"type":"string"},"values":{"description":"Property values","items":{"$ref":"#/definitions/Value"},"type":"array"}},"required":["id","name"],"type":"object"},"Recipient":{"description":"Recipient Information","properties":{"attach_screen_capture":{"default":false,"description":"Attach screen capture to E-mail alert","type":"boolean"},"attach_server_response":{"default":false,"description":"Attach server response to E-mail alert","type":"boolean"},"availability_alert":{"default":true,"description":"Receives availability alerts","type":"boolean"},"blackout_ids":{"default":[],"description":"IDs of attached blackout configurations.","items":{"description":"ID of a blackout configuration.","type":"integer"},"readOnly":true,"type":"array"},"has_test":{"description":"Test Notification is supported","type":"boolean"},"id":{"description":"Recipient id","type":"integer"},"method_description":{"description":"Method description","readOnly":true,"type":"string"},"method_id":{"default":12,"description":"Method id","enum":["12","1","4","2","5","3","6","21","11","10","16","8","9","19","20","14","17","18","15"],"type":"integer"},"name":{"default":"","description":"Recipient description","maxLength":128,"type":"string"},"notifier_groups":{"default":[],"description":"Recipient groups","items":{"description":"Recipient group id","type":"integer"},"readOnly":true,"type":"array"},"notify_on_clear":{"default":false,"description":"Notify when the error has cleared","type":"boolean"},"password":{"default":"","description":"Authentication Password","maxLength":255,"type":"string"},"performance_alert":{"default":false,"description":"Receives performance alerts","type":"boolean"},"performance_alert_type":{"default":"20","description":"Type of performance alert to send","enum":["20","10"],"type":"string"},"recipient":{"default":"","description":"Alert recipient","format":"email","type":"string"},"remote_commands":{"default":false,"description":"Enable remote commands","type":"boolean"},"repeat_performance_alerts":{"default":false,"description":"Repeat performance alerts","type":"boolean"},"start_threshold":{"default":1,"description":"Number of errors before notification starts","enum":[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],"type":"integer"},"stop_threshold":{"default":1,"description":"Number of errors before notification stops","enum":[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,50,75,100,125,150,175,200,500,1000,1500,2000],"type":"integer"},"username":{"default":"","description":"Authentication Username","maxLength":255,"type":"string"}},"required":["id","recipient","method_id","availability_alert","start_threshold","stop_threshold","notify_on_clear","attach_server_response","attach_screen_capture","remote_commands","performance_alert","repeat_performance_alerts","performance_alert_type"],"type":"object"},"SLA":{"description":"Service Level Agreements","properties":{"availability":{"description":"Availability percent","exclusiveMinimum":true,"maximum":100,"minimum":0,"type":"number"},"description":{"description":"SLA description","maxLength":100,"type":"string"},"exclusions":{"description":"Operating exclusions","items":{"$ref":"#/definitions/SlaExclusion"},"type":"array"},"id":{"description":"SLA id","type":"integer"},"metric":{"default":"resptime","description":"Response time metric","enum":["resptime","resptime_fullpage","dejatime_firstpaint","dejatime_afttime","dejatime_domload","dejatime_pageload","resptime_dns","resptime_connect","resptime_firstbyte","resptime_content"],"type":"string"},"metric_name":{"description":"Response Time Metric Name","readOnly":true,"type":"string"},"monitor_id":{"description":"Monitor id","type":"integer"},"monitor_name":{"description":"Monitor name","readOnly":true,"type":"string"},"name":{"description":"SLA name","maxLength":40,"type":"string"},"operating_periods":{"description":"Operating periods","items":{"$ref":"#/definitions/SlaOperatingPeriod"},"type":"array"},"response_time":{"description":"Response time seconds","exclusiveMinimum":true,"maximum":300,"minimum":0,"type":"number"},"secondary_response_time":{"description":"Secondary Apdex Response time seconds","type":"number"},"step_name":{"description":"Step name","readOnly":true,"type":"string"},"step_number":{"default":0,"description":"Step number","type":"integer"},"uptime":{"description":"Uptime percent","exclusiveMinimum":true,"maximum":100,"minimum":0,"type":"number"},"uptime_allowed":{"description":"Uptime allowed","readOnly":true,"type":"boolean"}},"required":["id","monitor_id","step_number","name","description"],"type":"object"},"SlaBulkEdit":{"description":"SLA Bulk Edit","properties":{"availability":{"description":"Availability percent","exclusiveMinimum":true,"maximum":100,"minimum":0,"type":"number"},"exclusions":{"description":"Operating exclusions","items":{"$ref":"#/definitions/SlaExclusion"},"type":"array"},"include_availability":{"description":"Include Availability with Service Level Objectives Update","type":"boolean"},"include_response_time":{"description":"Include Response Time with Service Level Objectives Update","type":"boolean"},"include_secondary_response_time":{"description":"Include Secondary Response with Service Level Objectives Update","type":"boolean"},"include_uptime":{"description":"Include Uptime with Service Level Objectives Update","type":"boolean"},"metric":{"default":"resptime","description":"Response time metric","enum":["resptime","resptime_fullpage","dejatime_firstpaint","dejatime_afttime","dejatime_domload","dejatime_pageload","resptime_dns","resptime_connect","resptime_firstbyte","resptime_content"],"type":"string"},"monitors":{"description":"Ids of assigned monitors","items":{"$ref":"#/definitions/SlaMonitor"},"type":"array"},"operating_periods":{"description":"Operating periods","items":{"$ref":"#/definitions/SlaOperatingPeriod"},"type":"array"},"response_time":{"description":"Response time seconds","exclusiveMinimum":true,"maximum":300,"minimum":0,"type":"number"},"secondary_response_time":{"description":"Secondary Apdex Response time seconds","type":"number"},"update_exclusions":{"description":"Update One-Time Exclusion Periods","type":"boolean"},"update_exclusions_action":{"description":"Append or Replace Existing Exclusion Periods","enum":["append","replace"],"type":"string"},"update_operating_periods":{"description":"Update Operating Periods","type":"boolean"},"update_sla_objectives":{"description":"Update Service Level Objectives","type":"boolean"},"uptime":{"description":"Uptime percent","exclusiveMinimum":true,"maximum":100,"minimum":0,"type":"number"}},"required":["update_sla_objectives","update_operating_periods","update_exclusions","monitors"],"type":"object"},"SlaExclusion":{"description":"Operating exclusion","properties":{"from_date":{"description":"Start datetime","format":"timestamp","type":"string"},"id":{"description":"SLA exclusion id","type":"integer"},"location_description":{"description":"Location description","readOnly":true,"type":"string"},"location_id":{"description":"Location id","type":"integer"},"note":{"description":"Exclusion note","maxLength":255,"type":"string"},"thru_date":{"description":"End datetime","format":"timestamp","type":"string"}},"required":["from_date","thru_date"],"type":"object"},"SlaMonitor":{"description":"Monitors","properties":{"id":{"description":"SLA id (update SLA)","type":"integer"},"monitor_id":{"description":"Monitor id (create SLA)","type":"integer"},"step_number":{"description":"Step number (create SLA)","type":"integer"}},"type":"object"},"SlaOperatingPeriod":{"description":"Operating period","properties":{"exclude":{"description":"Exclude operating period","type":"boolean"},"from_day":{"description":"Start day of week (Sunday=1)","maximum":7,"minimum":1,"type":"integer"},"from_time":{"description":"Start time (hh:mm)","format":"time_24_hhmm","type":"string"},"id":{"description":"SLA operating period id","type":"integer"},"thru_day":{"description":"End day of week (Sunday=1)","maximum":7,"minimum":1,"type":"integer"},"thru_time":{"description":"End time (hh:mm)","format":"time_24_hhmm","type":"string"}},"required":["from_day","from_time","thru_day","thru_time"],"type":"object"},"Test":{"description":"Run a Test On Demand","properties":{"id":{"description":"Test id","type":"integer"},"location_id":{"description":"Location id","type":"integer"},"monitor_agent":{"description":"Monitoring playback software","enum":["Default","Chrome 120","Chrome 74","Chrome 85","Chrome 99","Chrome Driver 120","Chrome Driver 74","Chrome Driver 85","Firefox 102","Firefox 52","Firefox 78","Firefox 91","Newman 5.3","ReadyAPI 1.9","ReadyAPI 3.59","TestEngine","TestEngine 1.23","TestEngine 1.27","TestEngine 1.33","TestEngine 1.7"],"type":"string"},"monitor_id":{"description":"Monitor id","type":"integer"},"recipients":{"description":"Comma separated E-mail addresses","type":"string"},"result_url":{"description":"URL to display Test Results","type":"string"},"test_type":{"description":"Test Type","enum":["Fullpage","Non-Fullpage","Traceroute","Ping","AlertSite Test"],"type":"string"},"type":{"description":"String representing monitor type.","enum":["website","website-ssl","email-imap","email-pop","email-smtp","ftp","ftp-ssl","name-server","ping","tcp"],"type":"string"},"url":{"description":"URL to test (if monitor_id is not used)","maxLength":65535,"type":"string"}},"type":"object"},"TestNotifier":{"description":"Send a test notfication","properties":{"location_id":{"description":"Location id","type":"integer"},"method_id":{"description":"Method id","enum":[1,2,3,4,5,6,21,10,11,12,14,15,16,17,18,19,20],"type":"integer"},"password":{"default":"","description":"Password","type":"string"},"recipient":{"description":"Alert recipient","type":"string"},"username":{"default":"","description":"Username","type":"string"}},"required":["recipient","method_id"],"type":"object"},"TestProgress":{"description":"Progress for a Test On Demand","properties":{"progress":{"description":"Test progress","enum":["0","1","2","3"],"type":"integer"},"progress_desc":{"description":"String representing test progress","enum":["Test Not Found","Test In Progress","Test Successful","Test Failed"],"type":"string"},"status":{"description":"Final status code for test","type":"integer"},"status_desc":{"description":"Description of status code","type":"string"}},"type":"object"},"User":{"description":"Users information","properties":{"current_password":{"description":"Old password to validate the password change","type":"string"},"date_joined":{"description":"Date joined","format":"date-time","readOnly":true,"type":"string"},"email":{"description":"Email","format":"email","maxLength":100,"type":"string"},"first_name":{"description":"First name","maxLength":20,"type":"string"},"guid":{"description":"User id","type":"string"},"home_phone":{"description":"Home phone","maxLength":20,"type":"string"},"is_locked_out":{"default":false,"description":"User is locked out","type":"boolean"},"is_sso_optional":{"default":false,"description":"User can use direct login if SSO is enabled","type":"boolean"},"last_api_access":{"description":"Last API Access","readOnly":true,"type":"string"},"last_console_access":{"description":"Last Console Access","readOnly":true,"type":"string"},"last_name":{"description":"Last name","maxLength":20,"type":"string"},"password":{"description":"Password","type":"string"},"role":{"description":"User role","enum":["ADMIN","CO-ADMIN","POWER-USER","READONLY","REPORTONLY"],"type":"string"},"user_number":{"description":"User Object id","readOnly":true,"type":"integer"},"work_phone":{"description":"Work phone","maxLength":20,"type":"string"}},"required":["guid","role","email","password","first_name","last_name","work_phone"],"type":"object"},"Value":{"description":"Values","properties":{"id":{"description":"Value id","type":"integer"},"name":{"description":"Value name","maxLength":255,"type":"string"}},"required":["id","name"],"type":"object"}},"host":"api.alertsite.com","info":{"description":"Most APIs require HTTP Authorization with an Access Token. At the top of the screen, click 'Authorize' or enter a value in the Access Token field.","title":"AlertSite API Swagger","version":"3.0"},"paths":{"/access-tokens":{"post":{"operationId":"getAccessToken","parameters":[{"description":"Login data","in":"body","name":"login_data","required":true,"schema":{"$ref":"#/definitions/LoginData"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Get Access Token","tags":["access-tokens"]}},"/blackouts":{"get":{"operationId":"getBlackouts","parameters":[{"description":"Type of blackout","enum":["Monitor","Notifier","Alert"],"in":"query","name":"type","required":false,"type":"string"},{"description":"Associated Monitor or Recipient ID for Blackout","in":"query","name":"assoc_id","required":false,"type":"integer"},{"description":"Return persistent blackouts only","in":"query","name":"persistent","required":false,"type":"boolean"},{"description":"Max number of records returned","in":"query","name":"limit","required":false,"type":"integer"},{"description":"Return records starting at record [offset]","in":"query","name":"offset","required":false,"type":"integer"},{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/Blackout"},"title":"Blackout","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch Blackouts","tags":["blackouts"]},"post":{"operationId":"createBlackout","parameters":[{"description":"The updated Blackout","in":"body","name":"Blackout","required":true,"schema":{"$ref":"#/definitions/Blackout"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Blackout","tags":["blackouts"]}},"/blackouts/bulk-edit":{"post":{"operationId":"bulk-edit-Blackout","parameters":[{"description":"The updated Blackout","in":"body","name":"Blackout","required":true,"schema":{"$ref":"#/definitions/BlackoutBulkEdit"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Bulk edit Blackouts","tags":["blackouts"]}},"/blackouts/{id}":{"delete":{"operationId":"deleteBlackout","parameters":[{"description":"Id of the Blackout to be deleted","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Delete a Blackout","tags":["blackouts"]},"get":{"operationId":"getBlackout","parameters":[{"description":"Id of the Blackout to be fetched","in":"path","name":"id","required":true,"type":"integer"},{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/Blackout"},"title":"Blackout","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch a Blackout by ID","tags":["blackouts"]},"patch":{"operationId":"modifyBlackout","parameters":[{"description":"Id of the Blackout to be modified","in":"path","name":"id","required":true,"type":"integer"},{"description":"The updated Blackout","in":"body","name":"Blackout","required":true,"schema":{"$ref":"#/definitions/Blackout"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Blackout","tags":["blackouts"]}},"/events":{"get":{"operationId":"getEvents","parameters":[{"description":"Relative date range for report","enum":["LastOneHour","LastTwoHours","LastFourHours","LastEightHours","LastTwelveHours","LastTwentyFourHours","LastFourtyEightHours","Today","Yesterday","LastTwoDays","LastThreeDays","LastSevenDays","LastEightDays","LastThirtyDays","ThisTwoDays","ThisThreeDays","ThisSevenDays","ThisEightDays","ThisThirtyDays","ThisWeek","ThisMonth","Last1Months","Last2Months","Last3Months","Last4Months","Last5Months","Last6Months","Last7Months","Last8Months","Last9Months","LastWeek","LastBizWeek","ThisQuarter","LastQuarter","ThisYear","LastYear"],"in":"query","name":"rdate","required":false,"type":"string"},{"description":"Start date/time for report","in":"query","name":"start_date","required":false,"type":"string"},{"description":"End date/time for report","in":"query","name":"end_date","required":false,"type":"string"},{"description":"Max number of records returned","in":"query","name":"limit","required":false,"type":"integer"},{"description":"Return records starting at record [offset]","in":"query","name":"offset","required":false,"type":"integer"},{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/Event"},"title":"Event","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch Events","tags":["events"]}},"/events/{event}":{"get":{"operationId":"getEventsByType","parameters":[{"description":"Event type to be fetched","enum":["All","ACCOUNT_ACTION","ADD_DATA_FEED","ADD_DATA_TEMPLATE","ADD_DEVICE","ADD_DEVICE_SLA","ADD_FULLPAGE_CREDIT","ADD_LOCATION_CREDIT","ADD_MONITORING_LOCATION","ADD_MONITOR_FILTER","ADD_MONITOR_GROUP","ADD_NOTIFIER","ADD_NOTIFIER_CREDIT","ADD_PRIVATE_LOCATION","ADD_PROPERTY","ADD_SINGLE_SIGNON","ADD_SITEPLAN_CREDIT","ADD_SLA_EXCLUSION","ADD_SLA_MULTIPOP_CREDIT","ADD_SLA_PERIOD","ADD_SOAPUI","ADD_SSL_CERT","ADD_USAGE_CREDIT","ADD_USER","CHANGE_BILLDATE_LAST","CHANGE_BILLDATE_NEXT","CHANGE_BILLING_FREQUENCY","CHANGE_DATA_FEED","CHANGE_DATA_RETENTION","CHANGE_DATA_TEMPLATE","CHANGE_MONITORING","CHANGE_MONITOR_FILTER","CHANGE_MONITOR_GROUP","CHANGE_MONITOR_TYPE","CHANGE_NOTIFIER_STATUS","CHANGE_PASSWORD","CHANGE_PRIMARY_LOCATION","CHANGE_PROPERTY","CHANGE_REQUESTED_END_DATE","CHANGE_SINGLE_SIGNON","CHANGE_SSL_CERT","CHANGE_USAGE_CONTRACT","CLEVERBRIDGE","CREATE_CUSTOMER_LOCATIONS","CUST_ACCEPT_AGREE","DELETE_CUSTOMER_LOCATIONS","DELETE_DATA_FEED","DELETE_DATA_TEMPLATE","DELETE_MONITOR_FILTER","DELETE_MONITOR_GROUP","DELETE_PROPERTY","DELETE_SINGLE_SIGNON","DELETE_SSL_CERT","DELETE_USER","DEL_DEVICE","DEL_MONITORING_LOCATION","DEL_NOTIFIER","DEL_PRIVATE_LOCATION","DISABLE_ALL_MONITORING","DISABLE_ALL_NOTIFIERS","DISABLE_ALL_SCANNING","DISABLE_MONITORING","EDIT_GA_LOGIN","EDIT_NOTIFIER_DISABLE","EDIT_NOTIFIER_ENABLE","EDIT_PRIVATE_LOCATION","EDIT_USER","ENABLE_ALL_MONITORING","ENABLE_ALL_NOTIFIERS","ENABLE_ALL_SCANNING","ENABLE_MONITORING","ENHANCED_PERMISSIONS","LOAD_ADDED","LOAD_CUST_CONFM","LOCKOUT_USER","REMOVE_BLACKOUTS_DEVICE","REMOVE_BLACKOUTS_NOTIFY","SET_BLACKOUTS_DEVICE","SET_BLACKOUTS_NOTIFY","SET_ONE_TIME_BLACKOUT_DEVICE","SET_ONE_TIME_BLACKOUT_NOTIFY","UPDATE_SLA_DEVICE","UPDATE_SOAPUI","UPD_CUST_STATUS","_All"],"in":"path","name":"event","required":true,"type":"string"},{"description":"Relative date range for report","enum":["LastOneHour","LastTwoHours","LastFourHours","LastEightHours","LastTwelveHours","LastTwentyFourHours","LastFourtyEightHours","Today","Yesterday","LastTwoDays","LastThreeDays","LastSevenDays","LastEightDays","LastThirtyDays","ThisTwoDays","ThisThreeDays","ThisSevenDays","ThisEightDays","ThisThirtyDays","ThisWeek","ThisMonth","Last1Months","Last2Months","Last3Months","Last4Months","Last5Months","Last6Months","Last7Months","Last8Months","Last9Months","LastWeek","LastBizWeek","ThisQuarter","LastQuarter","ThisYear","LastYear"],"in":"query","name":"rdate","required":false,"type":"string"},{"description":"Start date/time for report","in":"query","name":"start_date","required":false,"type":"string"},{"description":"End date/time for report","in":"query","name":"end_date","required":false,"type":"string"},{"description":"Max number of records returned","in":"query","name":"limit","required":false,"type":"integer"},{"description":"Return records starting at record [offset]","in":"query","name":"offset","required":false,"type":"integer"},{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/Event"},"title":"Event","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch Events by Event Type","tags":["events"]}},"/monitors":{"get":{"operationId":"getMonitors","parameters":[{"description":"Monitor type filter","in":"query","name":"type","required":false,"type":"string"},{"description":"Show scripts","in":"query","name":"show_scripts","required":false,"type":"boolean"},{"description":"Show script_children","in":"query","name":"show_script_children","required":false,"type":"boolean"},{"description":"Monitor has SLA","in":"query","name":"has_sla","required":false,"type":"boolean"},{"description":"Max number of records returned","in":"query","name":"limit","required":false,"type":"integer"},{"description":"Return records starting at record [offset]","in":"query","name":"offset","required":false,"type":"integer"},{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/Monitor"},"title":"Monitor","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch Monitors","tags":["monitors"]}},"/monitors/api":{"post":{"operationId":"postSOAPAPI","parameters":[{"description":"API Transaction","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorSOAPAPI"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new API Transaction","tags":["monitors"]}},"/monitors/api/{id}":{"patch":{"operationId":"modifySOAPAPI","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"API Transaction","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorSOAPAPI"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify an API Transaction","tags":["monitors"]}},"/monitors/bitbar":{"post":{"operationId":"postBitBar","parameters":[{"description":"BitBar Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorBitBar"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new BitBar Monitor","tags":["monitors"]}},"/monitors/bitbar/{id}":{"patch":{"operationId":"modifyBitBar","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"BitBar Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorBitBar"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a BitBar Monitor","tags":["monitors"]}},"/monitors/bulk-edit":{"patch":{"operationId":"bulk-edit-Monitor","parameters":[{"description":"Bulk edit type<br><b>validate_only</b>=Validate changes without any updates<br><b>ignore_errors</b>=Ignore errors and force allowable updates","enum":["validate_only","ignore_errors"],"in":"query","name":"bulk_edit_type","required":false,"type":"string"},{"description":"Monitors array with updated monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorBulkEdit"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Bulk edit Monitors","tags":["monitors"]}},"/monitors/bulk-edit/passwords":{"patch":{"operationId":"bulk-edit-Monitor-Passwords","parameters":[{"description":"Bulk edit type<br><b>validate_only</b>=Validate changes without any updates<br><b>ignore_errors</b>=Ignore errors and force allowable updates","enum":["validate_only","ignore_errors"],"in":"query","name":"bulk_edit_type","required":false,"type":"string"},{"description":"Monitors array with updated passwords","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorBulkEditPassword"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Bulk edit Monitor Passwords","tags":["monitors"]}},"/monitors/bulk-edit/scripts":{"patch":{"operationId":"bulk-edit-Monitor-Scripts","parameters":[{"description":"Bulk edit type<br><b>validate_only</b>=Validate changes without any updates<br><b>ignore_errors</b>=Ignore errors and force allowable updates","enum":["validate_only","ignore_errors"],"in":"query","name":"bulk_edit_type","required":false,"type":"string"},{"description":"Monitors array with updated values","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorBulkEditScript"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Bulk edit Monitor Scripts","tags":["monitors"]}},"/monitors/dejaclick":{"post":{"operationId":"postDejaClick","parameters":[{"description":"DejaClick Transaction","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorDejaClick"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new DejaClick Transaction","tags":["monitors"]}},"/monitors/dejaclick/{id}":{"patch":{"operationId":"modifyDejaClick","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"DejaClick Transaction","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorDejaClick"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a DejaClick Transaction","tags":["monitors"]}},"/monitors/email-imap":{"post":{"operationId":"postEmailIMAP","parameters":[{"description":"IMAP Email Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorEmailIMAP"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new IMAP Email Monitor","tags":["monitors"]}},"/monitors/email-imap/{id}":{"patch":{"operationId":"modifyEmailIMAP","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"IMAP Email Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorEmailIMAP"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify an IMAP Email Monitor","tags":["monitors"]}},"/monitors/email-pop":{"post":{"operationId":"postEmailPOP","parameters":[{"description":"POP3 Email Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorEmailPOP"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new POP3 Email Monitor","tags":["monitors"]}},"/monitors/email-pop/{id}":{"patch":{"operationId":"modifyEmailPOP","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"POP3 Email Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorEmailPOP"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a POP3 Email Monitor","tags":["monitors"]}},"/monitors/email-round-trip":{"post":{"operationId":"postEmailRoundtrip","parameters":[{"description":"Round-trip Email Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorEmailRoundtrip"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Round-trip Email Monitor","tags":["monitors"]}},"/monitors/email-round-trip/{id}":{"patch":{"operationId":"modifyEmailRoundtrip","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"Round-trip Email Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorEmailRoundtrip"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Round-trip Email Monitor","tags":["monitors"]}},"/monitors/email-smtp":{"post":{"operationId":"postEmailSMTP","parameters":[{"description":"SMTP Email Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorEmailSMTP"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new SMTP Email Monitor","tags":["monitors"]}},"/monitors/email-smtp/{id}":{"patch":{"operationId":"modifyEmailSMTP","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"SMTP Email Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorEmailSMTP"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a SMTP Email Monitor","tags":["monitors"]}},"/monitors/ftp":{"post":{"operationId":"postFTP","parameters":[{"description":"FTP Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorFTP"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new FTP Monitor","tags":["monitors"]}},"/monitors/ftp-ssl":{"post":{"operationId":"postFTPS","parameters":[{"description":"FTPS Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorFTPS"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new FTPS Monitor","tags":["monitors"]}},"/monitors/ftp-ssl/{id}":{"patch":{"operationId":"modifyFTPS","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"FTPS Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorFTPS"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a FTPS Monitor","tags":["monitors"]}},"/monitors/ftp/{id}":{"patch":{"operationId":"modifyFTP","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"FTP Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorFTP"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a FTP Monitor","tags":["monitors"]}},"/monitors/name-server":{"post":{"operationId":"postDNS","parameters":[{"description":"DNS Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorDNS"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new DNS Monitor","tags":["monitors"]}},"/monitors/name-server/{id}":{"patch":{"operationId":"modifyDNS","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"DNS Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorDNS"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a DNS Monitor","tags":["monitors"]}},"/monitors/perfecto":{"post":{"operationId":"postPerfecto","parameters":[{"description":"Perfecto Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorPerfecto"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Perfecto Monitor","tags":["monitors"]}},"/monitors/perfecto/{id}":{"patch":{"operationId":"modifyPerfecto","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"Perfecto Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorPerfecto"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Perfecto Monitor","tags":["monitors"]}},"/monitors/ping":{"post":{"operationId":"postPing","parameters":[{"description":"Ping Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorPing"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Ping Monitor","tags":["monitors"]}},"/monitors/ping/{id}":{"patch":{"operationId":"modifyPing","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"Ping Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorPing"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Ping Monitor","tags":["monitors"]}},"/monitors/postman-api":{"post":{"operationId":"postPostman","parameters":[{"description":"Postman API Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorPostman"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Postman API Monitor","tags":["monitors"]}},"/monitors/postman-api/{id}":{"patch":{"operationId":"modifyPostman","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"Postman API Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorPostman"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Postman API Monitor","tags":["monitors"]}},"/monitors/selenium":{"post":{"operationId":"postSelenium","parameters":[{"description":"Selenium Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorSelenium"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Selenium Monitor","tags":["monitors"]}},"/monitors/selenium/{id}":{"patch":{"operationId":"modifySelenium","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"Selenium Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorSelenium"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Selenium Monitor","tags":["monitors"]}},"/monitors/tcp":{"post":{"operationId":"postTCP","parameters":[{"description":"TCP Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorTCP"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new TCP Monitor","tags":["monitors"]}},"/monitors/tcp/{id}":{"patch":{"operationId":"modifyTCP","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"TCP Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorTCP"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a TCP Monitor","tags":["monitors"]}},"/monitors/website":{"post":{"operationId":"postWebsite","parameters":[{"description":"Website Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorWebsite"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Website Monitor","tags":["monitors"]}},"/monitors/website-api":{"post":{"operationId":"postWebsiteAPI","parameters":[{"description":"Website API Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorWebsiteAPI"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Website API Monitor","tags":["monitors"]}},"/monitors/website-api/{id}":{"patch":{"operationId":"modifyWebsiteAPI","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"Website API Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorWebsiteAPI"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Website API Monitor","tags":["monitors"]}},"/monitors/website-api/{id}/convert-api":{"patch":{"operationId":"convertWebsiteAPI","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Convert a Website API Monitor to SoapUI","tags":["monitors"]}},"/monitors/website-ssl":{"post":{"operationId":"postWebsiteSSL","parameters":[{"description":"Secure Website Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorWebsiteSSL"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Secure Website Monitor","tags":["monitors"]}},"/monitors/website-ssl-api":{"post":{"operationId":"postWebsiteSSLAPI","parameters":[{"description":"Secure Website API Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorWebsiteSSLAPI"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Secure Website API Monitor","tags":["monitors"]}},"/monitors/website-ssl-api/{id}":{"patch":{"operationId":"modifyWebsiteSSLAPI","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"Secure Website API Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorWebsiteSSLAPI"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Secure Website API Monitor","tags":["monitors"]}},"/monitors/website-ssl-api/{id}/convert-api":{"patch":{"operationId":"convertWebsiteSSLAPI","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Convert a Secure Website API Monitor to SoapUI","tags":["monitors"]}},"/monitors/website-ssl/{id}":{"patch":{"operationId":"modifyWebsiteSSL","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"Secure Website Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorWebsiteSSL"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Secure Website Monitor","tags":["monitors"]}},"/monitors/website/{id}":{"patch":{"operationId":"modifyWebsite","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"Website Monitor","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MonitorWebsite"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Website Monitor","tags":["monitors"]}},"/monitors/{id}":{"delete":{"operationId":"deleteMonitor","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Delete a Monitor","tags":["monitors"]},"get":{"operationId":"getMonitor","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"Show scripts","in":"query","name":"show_scripts","required":false,"type":"boolean"},{"description":"Show script_children","in":"query","name":"show_script_children","required":false,"type":"boolean"},{"description":"Download script as zip file","in":"query","name":"download_script","required":false,"type":"boolean"},{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/Monitor"},"title":"Monitor","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch a Monitor by ID","tags":["monitors"]}},"/monitors/{id}/clone":{"post":{"operationId":"cloneMonitor","parameters":[{"description":"Monitor id","in":"path","name":"id","required":true,"type":"integer"},{"description":"Cloned Monitor","in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MonitorClone"}}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/MonitorClone"},"title":"MonitorClone","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Clone a Monitor","tags":["monitors"]}},"/notifier-groups":{"get":{"operationId":"getNotifierGroups","parameters":[{"description":"Monitor id","in":"query","name":"monitor_id","required":false,"type":"integer"},{"description":"Recipient id","in":"query","name":"recipient_id","required":false,"type":"integer"},{"description":"Max number of records returned","in":"query","name":"limit","required":false,"type":"integer"},{"description":"Return records starting at record [offset]","in":"query","name":"offset","required":false,"type":"integer"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/NotifierGroup"},"title":"NotifierGroup","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch Notifier Groups","tags":["notifier-groups"]},"post":{"operationId":"createNotifierGroup","parameters":[{"description":"The updated Notifier Group","in":"body","name":"recipient","required":true,"schema":{"$ref":"#/definitions/NotifierGroup"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Notifier Group","tags":["notifier-groups"]}},"/notifier-groups/{id}":{"delete":{"operationId":"deleteNotifierGroup","parameters":[{"description":"Id of the Notifier Group to be deleted","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Delete a Notifier Group","tags":["notifier-groups"]},"get":{"operationId":"getNotifierGroup","parameters":[{"description":"Id of the Notifier Group to be fetched","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/NotifierGroup"},"title":"NotifierGroup","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch a Notifier Group by ID","tags":["notifier-groups"]},"patch":{"operationId":"modifyNotifierGroup","parameters":[{"description":"Id of the Notifier Group to be modified","in":"path","name":"id","required":true,"type":"integer"},{"description":"The updated Notifier Group","in":"body","name":"recipient","required":true,"schema":{"$ref":"#/definitions/NotifierGroup"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Notifier Group","tags":["notifier-groups"]}},"/perf-alerts":{"get":{"operationId":"getPerfAlerts","parameters":[{"description":"Max number of records returned","in":"query","name":"limit","required":false,"type":"integer"},{"description":"Return records starting at record [offset]","in":"query","name":"offset","required":false,"type":"integer"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/PerfAlert"},"title":"PerfAlert","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch Performance Alerts","tags":["perf-alerts"]},"post":{"operationId":"createPerfAlert","parameters":[{"description":"The updated Performance Alert","in":"body","name":"perfalert","required":true,"schema":{"$ref":"#/definitions/PerfAlert"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Performance Alert","tags":["perf-alerts"]}},"/perf-alerts/{id}":{"get":{"operationId":"getPerfAlert","parameters":[{"description":"Id of the Performance Alert to be fetched","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/PerfAlert"},"title":"PerfAlert","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch a Performance Alert by ID","tags":["perf-alerts"]}},"/perf-alerts/{id}/{step_number}":{"delete":{"operationId":"deletePerfAlert","parameters":[{"description":"Id of the Performance Alert to be deleted","in":"path","name":"id","required":true,"type":"integer"},{"description":"Step Number","in":"path","name":"step_number","required":true,"type":"integer"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Delete a Performance Alert","tags":["perf-alerts"]},"get":{"operationId":"getPerfAlertStep","parameters":[{"description":"Id of the Performance Alert to be fetched","in":"path","name":"id","required":true,"type":"integer"},{"description":"Step Number","in":"path","name":"step_number","required":true,"type":"integer"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/PerfAlert"},"title":"PerfAlert","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch a Performance Alert by ID and Step","tags":["perf-alerts"]},"patch":{"operationId":"modifyPerfAlert","parameters":[{"description":"Id of the Performance Alert to be modified","in":"path","name":"id","required":true,"type":"integer"},{"description":"Step Number","in":"path","name":"step_number","required":true,"type":"integer"},{"description":"The updated Performance Alert","in":"body","name":"perfalert","required":true,"schema":{"$ref":"#/definitions/PerfAlert"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Performance Alert","tags":["perf-alerts"]}},"/properties":{"get":{"operationId":"getProperties","parameters":[{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/Property"},"title":"Property","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch Custom Properties","tags":["properties"]},"post":{"operationId":"createProperty","parameters":[{"description":"The new Custom Property","in":"body","name":"property","required":true,"schema":{"$ref":"#/definitions/Property"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a Custom Property","tags":["properties"]}},"/properties/{id}":{"delete":{"operationId":"deleteProperty","parameters":[{"description":"ID of the Custom Property to be deleted","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Delete a Custom Property","tags":["properties"]},"get":{"operationId":"getProperty","parameters":[{"description":"Id of the Custom Property to be fetched","in":"path","name":"id","required":true,"type":"integer"},{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/Property"},"title":"Property","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch a Custom Property Group by ID","tags":["properties"]},"patch":{"operationId":"modifyProperty","parameters":[{"description":"ID of the Custom Property to be modified","in":"path","name":"id","required":true,"type":"integer"},{"description":"The updated Custom Property","in":"body","name":"property","required":true,"schema":{"$ref":"#/definitions/Property"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Custom Property","tags":["properties"]}},"/recipients":{"get":{"operationId":"getRecipients","parameters":[{"description":"Type of Recipient","enum":["Availability","Performance"],"in":"query","name":"type","required":false,"type":"string"},{"description":"Notify Method","enum":["1","2","3","4","5","6","8","9","10","11","12","14","15","16","17","18","19","20","21"],"in":"query","name":"method_id","required":false,"type":"integer"},{"description":"Max number of records returned","in":"query","name":"limit","required":false,"type":"integer"},{"description":"Return records starting at record [offset]","in":"query","name":"offset","required":false,"type":"integer"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/Recipient"},"title":"Recipient","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch Recipients","tags":["recipients"]},"post":{"operationId":"createRecipient","parameters":[{"description":"The updated Recipient","in":"body","name":"recipient","required":true,"schema":{"$ref":"#/definitions/Recipient"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new Recipient","tags":["recipients"]}},"/recipients/{id}":{"delete":{"operationId":"deleteRecipient","parameters":[{"description":"Id of the Recipient to be deleted","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Delete a Recipient","tags":["recipients"]},"get":{"operationId":"getRecipient","parameters":[{"description":"Id of the Recipient to be fetched","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/Recipient"},"title":"Recipient","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch a Recipient by ID","tags":["recipients"]},"patch":{"operationId":"modifyRecipient","parameters":[{"description":"Id of the Recipient to be modified","in":"path","name":"id","required":true,"type":"integer"},{"description":"The updated Recipient","in":"body","name":"recipient","required":true,"schema":{"$ref":"#/definitions/Recipient"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a Recipient","tags":["recipients"]}},"/report-sitestatus":{"get":{"operationId":"getSiteStatus","parameters":[{"description":"Comma separated list of monitor ids","in":"query","name":"monitors","required":false,"type":"string"},{"description":"Comma separated list of Monitor Group ids","in":"query","name":"monitor_groups","required":false,"type":"string"},{"description":"Comma separated list of monitor types (api, bitbar, dejaclick, email-imap, email-pop, email-round-trip, email-smtp, ftp, ftp-ssl, name-server, perfecto, ping, postman-api, security-scan, selenium, serveragent, tcp, transaction, transaction-ssl, website, website-api, website-ssl, website-ssl-api)","in":"query","name":"type","required":false,"type":"string"},{"description":"Summarize results by monitor id when selecting monitors","in":"query","name":"summarize","required":false,"type":"boolean"},{"description":"Include monitor note status","in":"query","name":"shownotes","required":false,"type":"boolean"},{"description":"Only show monitors in error status","in":"query","name":"onlyerrors","required":false,"type":"boolean"},{"description":"Only show monitors in OK status","in":"query","name":"onlyok","required":false,"type":"boolean"},{"description":"Only show monitors where monitoring is enabled","in":"query","name":"enabledonly","required":false,"type":"boolean"},{"description":"Show all sub accounts","in":"query","name":"showsubaccounts","required":false,"type":"boolean"},{"description":"Comma separated list of sub account ids","in":"query","name":"sub_accounts","required":false,"type":"string"},{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch site status report","tags":["report-sitestatus"]}},"/slas":{"get":{"operationId":"getSLAs","parameters":[{"description":"Monitor ID","in":"query","name":"monitor_id","required":false,"type":"integer"},{"description":"Max number of records returned","in":"query","name":"limit","required":false,"type":"integer"},{"description":"Return records starting at record [offset]","in":"query","name":"offset","required":false,"type":"integer"},{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/SLA"},"title":"SLA","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch SLAs","tags":["slas"]},"post":{"operationId":"createSLA","parameters":[{"description":"The updated SLA","in":"body","name":"SLA","required":true,"schema":{"$ref":"#/definitions/SLA"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new SLA","tags":["slas"]}},"/slas/bulk-edit":{"post":{"operationId":"bulk-edit-SLA","parameters":[{"description":"The updated SLA","in":"body","name":"SLA","required":true,"schema":{"$ref":"#/definitions/SlaBulkEdit"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Bulk edit SLAs","tags":["slas"]}},"/slas/{id}":{"delete":{"operationId":"deleteSLA","parameters":[{"description":"Id of the SLA to be deleted","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Delete a SLA","tags":["slas"]},"get":{"operationId":"getSLA","parameters":[{"description":"Id of the SLA to be fetched","in":"path","name":"id","required":true,"type":"integer"},{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/SLA"},"title":"SLA","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch a SLA by ID","tags":["slas"]},"patch":{"operationId":"modifySLA","parameters":[{"description":"Id of the SLA to be modified","in":"path","name":"id","required":true,"type":"integer"},{"description":"The updated SLA","in":"body","name":"SLA","required":true,"schema":{"$ref":"#/definitions/SLA"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a SLA","tags":["slas"]}},"/test-notifiers":{"post":{"operationId":"createTestNotification","parameters":[{"description":"Notification information","in":"body","name":"test_notification","required":true,"schema":{"$ref":"#/definitions/TestNotifier"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Send a Test Notification","tags":["test-notifiers"]}},"/tests/{id}":{"get":{"operationId":"getTest","parameters":[{"description":"Test id","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/TestProgress"},"title":"TestProgress","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Get Test On Demand progress","tags":["tests"]}},"/users":{"get":{"operationId":"getUsers","parameters":[{"description":"Max number of records returned","in":"query","name":"limit","required":false,"type":"integer"},{"description":"Return records starting at record [offset]","in":"query","name":"offset","required":false,"type":"integer"},{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/User"},"title":"User","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch Users","tags":["users"]},"post":{"operationId":"createUser","parameters":[{"description":"The updated User","in":"body","name":"user","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Create a new User","tags":["users"]}},"/users/{guid}":{"delete":{"operationId":"deleteUser","parameters":[{"description":"Id of the User to be deleted","in":"path","name":"guid","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Delete a User","tags":["users"]},"get":{"operationId":"getUser","parameters":[{"description":"Id of the User to be fetched","in":"path","name":"guid","required":true,"type":"string"},{"description":"A comma separated list of fields to filter the result set by","in":"query","name":"select","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"items":{"$ref":"#/definitions/User"},"title":"User","type":"array"}},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Fetch a User by ID","tags":["users"]},"patch":{"operationId":"modifyUser","parameters":[{"description":"Id of the User to be modified","in":"path","name":"guid","required":true,"type":"string"},{"description":"The updated User","in":"body","name":"user","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid Request"},"401":{"description":"Not Authenticated"},"403":{"description":"Not Authorized"},"404":{"description":"Not Found"}},"summary":"Modify a User","tags":["users"]}}},"swagger":"2.0","tags":[{"description":"Get Access Token","name":"access-tokens"},{"description":"Operations about Blackouts","name":"blackouts"},{"description":"Operations about Events","name":"events"},{"description":"Operations about Monitors","name":"monitors"},{"description":"Operations about Notifier Groups","name":"notifier-groups"},{"description":"Operations about Performance Alerts","name":"perf-alerts"},{"description":"Operations about Custom Properties","name":"properties"},{"description":"Operations about Recipients","name":"recipients"},{"description":"Site Status Reporting","name":"report-sitestatus"},{"description":"Operations about SLAs","name":"slas"},{"description":"Operations about Test Notifications","name":"test-notifiers"},{"description":"Operations about Tests On Demand","name":"tests"},{"description":"Operations about Users","name":"users"}]}