UptimeRobot · Schema

MonitorDto

Uptime MonitoringStatus PagesIncident ManagementDevOpsMonitoring Integrations

Properties

Name Type Description
type object
interval number
sslBrand stringnull
sslExpiryDateTime object
domainExpireDate object
checkSSLErrors boolean
sslExpirationReminder booleannull
domainExpirationReminder booleannull
followRedirections boolean
authType object
httpUsername string
httpPassword string
customHttpHeaders objectnull
httpMethodType object
successHttpResponseCodes array
timeout numbernull
postValueData object
postValueType stringnull
port numbernull
portAlertCondition object
gracePeriod numbernull
keywordValue stringnull
keywordCaseType object
keywordType object
responseTimeThreshold number
config objectnull
regionalData object
heartbeatUrl stringnull Complete heartbeat ping URL for HEARTBEAT monitors; null for every other type
maintenanceWindows array
psps array
id number
friendlyName string
status object
url stringnull
currentStateDuration number
lastIncidentId stringnull
userId number
tags array
assignedAlertContacts array
lastIncident objectnull
lastDayUptimes object
createDateTime object
apiKey stringnull
groupId numbernull
customFields objectnull
View JSON Schema on GitHub

JSON Schema

uptimerobot-monitor-dto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uptimerobot/main/json-schema/uptimerobot-monitor-dto-schema.json",
  "title": "MonitorDto",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/uptimerobot-openapi.yaml#/components/schemas/MonitorDto",
  "type": "object",
  "properties": {
    "type": {},
    "interval": {
      "type": "number",
      "minimum": 15,
      "exclusiveMinimum": false,
      "maximum": 2678400,
      "exclusiveMaximum": false
    },
    "sslBrand": {
      "type": [
        "string",
        "null"
      ]
    },
    "sslExpiryDateTime": {
      "oneOf": [
        {},
        {
          "type": "string"
        }
      ],
      "nullable": true
    },
    "domainExpireDate": {
      "oneOf": [
        {},
        {
          "type": "string"
        }
      ],
      "nullable": true
    },
    "checkSSLErrors": {
      "type": "boolean"
    },
    "sslExpirationReminder": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "domainExpirationReminder": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "followRedirections": {
      "type": "boolean"
    },
    "authType": {
      "nullable": true
    },
    "httpUsername": {
      "type": "string"
    },
    "httpPassword": {
      "type": "string"
    },
    "customHttpHeaders": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "number"
          }
        ]
      }
    },
    "httpMethodType": {
      "nullable": true
    },
    "successHttpResponseCodes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "timeout": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0,
      "exclusiveMinimum": false,
      "maximum": 90,
      "exclusiveMaximum": false
    },
    "postValueData": {
      "oneOf": [
        {
          "oneOf": [
            {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                }
              ]
            },
            {
              "type": "object",
              "additionalProperties": {}
            }
          ]
        },
        {
          "type": "array",
          "items": {}
        }
      ],
      "nullable": true
    },
    "postValueType": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "KEY_VALUE",
        "RAW_JSON"
      ],
      "x-enumNames": [
        "KEY_VALUE",
        "RAW_JSON"
      ]
    },
    "port": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0,
      "exclusiveMinimum": false,
      "maximum": 65535,
      "exclusiveMaximum": false
    },
    "portAlertCondition": {},
    "gracePeriod": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0,
      "exclusiveMinimum": false,
      "maximum": 86400,
      "exclusiveMaximum": false
    },
    "keywordValue": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 0,
      "maxLength": 500
    },
    "keywordCaseType": {
      "oneOf": [
        {
          "type": "number",
          "minimum": 0,
          "maximum": 0
        },
        {
          "type": "number",
          "minimum": 1,
          "maximum": 1
        }
      ],
      "nullable": true
    },
    "keywordType": {
      "nullable": true
    },
    "responseTimeThreshold": {
      "type": "number"
    },
    "config": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "dnsRecords": {
          "type": "object",
          "properties": {
            "CNAME": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "MX": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "NS": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "A": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "AAAA": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "TXT": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "SRV": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "PTR": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "SOA": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "SPF": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "DNSKEY": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "DS": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "NSEC": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "NSEC3": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "apiAssertions": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "logic": {
                  "type": "string",
                  "enum": [
                    "AND",
                    "OR"
                  ]
                },
                "checks": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "property": {
                        "type": "string"
                      },
                      "comparison": {
                        "type": "string",
                        "enum": [
                          "equals",
                          "not_equals",
                          "contains",
                          "not_contains",
                          "greater_than",
                          "less_than",
                          "is_null",
                          "is_not_null",
                          "is_string",
                          "is_number",
                          "is_boolean",
                          "is_array",
                          "is_object",
                          "is_empty",
                          "is_not_empty",
                          "length_equals",
                          "length_not_equals",
                          "length_greater_than",
                          "length_less_than",
                          "exists",
                          "not_exists"
                        ],
                        "x-enumNames": [
                          "EQUALS",
                          "NOT_EQUALS",
                          "CONTAINS",
                          "NOT_CONTAINS",
                          "GREATER_THAN",
                          "LESS_THAN",
                          "IS_NULL",
                          "IS_NOT_NULL",
                          "IS_STRING",
                          "IS_NUMBER",
                          "IS_BOOLEAN",
                          "IS_ARRAY",
                          "IS_OBJECT",
                          "IS_EMPTY",
                          "IS_NOT_EMPTY",
                          "LENGTH_EQUALS",
                          "LENGTH_NOT_EQUALS",
                          "LENGTH_GREATER_THAN",
                          "LENGTH_LESS_THAN",
                          "EXISTS",
                          "NOT_EXISTS"
                        ]
                      },
                      "target": {},
                      "id": {
                        "oneOf": [
                          {
                            "type": "string",
                            "maxLength": 128
                          },
                          {
                            "type": "integer",
                            "minimum": -9007199254740991,
                            "exclusiveMinimum": false,
                            "maximum": 9007199254740991,
                            "exclusiveMaximum": false
                          }
                        ]
                      },
                      "index": {
                        "type": "integer",
                        "minimum": 0,
                        "exclusiveMinimum": false,
                        "maximum": 9007199254740991,
                        "exclusiveMaximum": false
                      }
                    },
                    "required": [
                      "property",
                      "comparison"
                    ]
                  }
                }
              },
              "required": [
                "logic",
                "checks"
              ]
            },
            {
              "type": "object",
              "properties": {}
            }
          ]
        },
        "sslExpirationPeriodDays": {
          "type": "array",
          "maxItems": 10,
          "items": {
            "type": "integer",
            "minimum": 0,
            "exclusiveMinimum": false,
            "maximum": 365,
            "exclusiveMaximum": false
          }
        },
        "udp": {
          "type": "object",
          "properties": {
            "payload": {
              "type": "string"
            },
            "packetLossThreshold": {
              "type": "number"
            }
          },
          "required": [
            "packetLossThreshold"
          ]
        },
        "ipVersion": {
          "type": "string",
          "enum": [
            "ipv4Only",
            "ipv6Only"
          ]
        },
        "applicationErrorRetries": {
          "type": "integer",
          "minimum": 0,
          "exclusiveMinimum": false,
          "maximum": 3,
          "exclusiveMaximum": false
        },
        "visualComparison": {
          "type": "object",
          "properties": {
            "sensitivityThreshold": {
              "type": "integer",
              "minimum": 0,
              "exclusiveMinimum": false,
              "maximum": 100,
              "exclusiveMaximum": false
            },
            "viewport": {
              "type": "string",
              "enum": [
                "desktop",
                "mobile"
              ]
            },
            "areaCoordinates": {
              "type": "object",
              "properties": {
                "percentX": {
                  "type": "number",
                  "minimum": 0,
                  "exclusiveMinimum": false,
                  "maximum": 100,
                  "exclusiveMaximum": false
                },
                "percentY": {
                  "type": "number",
                  "minimum": 0,
                  "exclusiveMinimum": false,
                  "maximum": 100,
                  "exclusiveMaximum": false
                },
                "percentWidth": {
                  "type": "number",
                  "minimum": 0,
                  "exclusiveMinimum": false,
                  "maximum": 100,
                  "exclusiveMaximum": false
                },
                "percentHeight": {
                  "type": "number",
                  "minimum": 0,
                  "exclusiveMinimum": false,
                  "maximum": 100,
                  "exclusiveMaximum": false
                }
              },
              "required": [
                "percentX",
                "percentY",
                "percentWidth",
                "percentHeight"
              ]
            },
            "refreshBaseline": {
              "type": "boolean"
            },
            "userBaselinePath": {
              "type": "string"
            },
            "lastCheckBaselinePath": {
              "type": "string"
            }
          },
          "required": [
            "sensitivityThreshold",
            "viewport"
          ]
        },
        "dependency": {
          "type": "object",
          "properties": {
            "providerUrlname": {
              "type": "string",
              "minLength": 1
            },
            "trackedComponentIds": {
              "type": [
                "array",
                "null"
              ],
              "items": {
                "type": "integer"
              }
            },
            "currentState": {
              "type": "string",
              "enum": [
                "operational",
                "minor",
                "major",
                "maintenance"
              ]
            },
            "needsReview": {
              "type": "boolean"
            },
            "notify": {
              "type": "object",
              "properties": {
                "severity": {
                  "type": "string",
                  "enum": [
                    "all",
                    "major",
                    "none"
                  ]
                },
                "incrementalUpdates": {
                  "type": "boolean"
                }
              },
              "required": [
                "severity",
                "incrementalUpdates"
              ]
            },
            "maintenanceNotificationsEnabled": {
              "type": "boolean"
            }
          },
          "required": [
            "providerUrlname",
            "currentState",
            "needsReview",
            "notify"
          ]
        }
      }
    },
    "regionalData": {
      "type": "object",
      "properties": {
        "REGION": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "na",
              "eu",
              "as",
              "oc"
            ],
            "x-enumNames": [
              "NorthAmerica",
              "Europe",
              "Asia",
              "Oceania"
            ]
          }
        },
        "MANUAL_SELECTED": {
          "type": "boolean"
        },
        "INFRASTRUCTURE": {
          "type": "string",
          "enum": [
            "Legacy",
            "New"
          ],
          "x-enumNames": [
            "Legacy",
            "New"
          ]
        },
        "THRESHOLD": {
          "type": "object",
          "additionalProperties": {
            "type": "number",
            "minimum": 0,
            "exclusiveMinimum": false,
            "maximum": 60000,
            "exclusiveMaximum": false
          }
        }
      },
      "required": [
        "REGION"
      ]
    },
    "heartbeatUrl": {
      "description": "Complete heartbeat ping URL for HEARTBEAT monitors; null for every other type",
      "type": [
        "string",
        "null"
      ]
    },
    "maintenanceWindows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "minimum": 0,
            "exclusiveMinimum": false
          },
          "userId": {
            "type": "number",
            "minimum": 0,
            "exclusiveMinimum": false
          },
          "name": {
            "type": "string",
            "minLength": 3
          },
          "interval": {
            "type": "string",
            "enum": [
              "once",
              "daily",
              "weekly",
              "monthly"
            ],
            "x-enumNames": [
              "once",
              "daily",
              "weekly",
              "monthly"
            ]
          },
          "date": {
            "type": [
              "string",
              "null"
            ]
          },
          "time": {
            "type": "string",
            "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"
          },
          "duration": {
            "type": "number",
            "minimum": 1,
            "exclusiveMinimum": false
          },
          "autoAddMonitors": {
            "type": "boolean"
          },
          "monitorIds": {
            "type": "array",
            "items": {
              "type": "number"
            }
          },
          "days": {
            "type": "array",
            "items": {
              "type": "number"
            }
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "paused"
            ],
            "x-enumNames": [
              "active",
              "paused"
            ]
          },
          "created": {
            "oneOf": [
              {},
              {
                "type": "string"
              }
            ]
          }
        },
        "required": [
          "id",
          "userId",
          "name",
          "interval",
          "date",
          "time",
          "duration",
          "autoAddMonitors",
          "monitorIds",
          "days",
          "status",
          "created"
        ]
      }
    },
    "psps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 0,
            "exclusiveMinimum": false
          },
          "friendlyName": {
            "type": "string",
            "minLength": 1
          },
          "customDomain": {
            "type": [
              "string",
              "null"
            ]
          },
          "isPasswordSet": {
            "type": "boolean"
          },
          "monitorIds": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "number"
            }
          },
          "tagIds": {
            "type": "array",
            "items": {
              "type": "number"
            }
          },
          "monitorsCount": {
            "type": [
              "number",
              "null"
            ]
          },
          "status": {},
          "urlKey": {
            "type": "string",
            "minLength": 1
          },
          "homepageLink": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 3
          },
          "gaCode": {
            "type": [
              "string",
              "null"
            ]
          },
          "shareAnalyticsConsent": {
            "type": "boolean"
          },
          "useSmallCookieConsentModal": {
            "type": "boolean"
          },
          "icon": {
            "type": [
              "string",
              "null"
            ]
          },
          "noIndex": {
            "type": "boolean"
          },
          "logo": {
            "type": [
              "string",
              "null"
            ]
          },
          "hideUrlLinks": {
            "type": "boolean"
          },
          "subscription": {
            "type": "boolean"
          },
          "showCookieBar": {
            "type": "boolean"
          },
          "pinnedAnnouncementId": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0,
            "exclusiveMinimum": false
          },
          "customSettings": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "font": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "family": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "required": [
                  "family"
                ]
              },
              "page": {
                "type": "object",
                "properties": {
                  "layout": {
                    "type": "string"
                  },
                  "theme": {
                    "type": "string",
                    "enum": [
                      "light",
                      "dark"
                    ]
                  },
                  "density": {
                    "type": "string",
                    "enum": [
                      "normal",
                      "compact"
                    ]
                  }
                }
              },
              "colors": {
                "type": "object",
                "properties": {
                  "main": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "text": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "link": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "required": [
                  "main",
                  "text",
                  "link"
                ]
              },
              "features": {
                "type": "object",
                "properties": {
                  "showBars": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "true",
                      "false"
                    ]
                  },
                  "showUptimePercentage": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "true",
                      "false"
                    ]
                  },
                  "enableFloatingStatus": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "true",
                      "false"
                    ]
                  },
                  "showOverallUptime": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "true",
                      "false"
                    ]
                  },
                  "showOutageUpdates": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "true",
                      "false"
                    ]
                  },
                  "showOutageDetails": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "true",
                      "false"
                    ]
                  },
                  "enableDetailsPage": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "true",
                      "false"
                    ]
                  },
                  "showMonitorURL": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "true",
                      "false"
                    ]
                  },
                  "hidePausedMonitors": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "enum": [
                      "true",
                      "false"
                    ]
                  }
                },
                "required": [
                  "showUptimePercentage"
                ]
              }
            }
          }
        },
        "required": [
          "id",
          "friendlyName",
          "customDomain",
          "isPasswordSet",
          "monitorIds",
          "tagIds",
          "monitorsCount",
          "status",
          "urlKey",
          "homepageLink",
          "gaCode",
          "shareAnalyticsConsent",
          "useSmallCookieConsentModal",
          "icon",
          "noIndex",
          "logo",
          "hideUrlLinks",
          "subscription",
          "showCookieBar",
          "pinnedAnnouncementId",
          "customSettings"
        ]
      }
    },
    "id": {
      "type": "number",
      "minimum": 0,
      "exclusiveMinimum": false
    },
    "friendlyName": {
      "type": "string",
      "minLength": 1
    },
    "status": {},
    "url": {
      "type": [
        "string",
        "null"
      ]
    },
    "currentStateDuration": {
      "type": "number"
    },
    "lastIncidentId": {
      "type": [
        "string",
        "null"
      ]
    },
    "userId": {
      "type": "number",
      "minimum": 0,
      "exclusiveMinimum": false
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "minimum": 0,
            "exclusiveMinimum": false
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "color": {
            "type": "string",
            "minLength": 1
          },
          "monitors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "minimum": 0,
                  "exclusiveMinimum": false
                },
                "friendlyName": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "minLength": 1
                },
                "status": {},
                "url": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "friendlyName",
                "status",
                "url"
              ]
            }
          }
        },
        "required": [
          "id",
          "name",
          "color"
        ]
      }
    },
    "assignedAlertContacts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "alertContactId": {
            "type": "number"
          },
          "threshold": {
            "type": "number",
            "minimum": 0,
            "exclusiveMinimum": false
          },
          "recurrence": {
            "type": "number",
            "minimum": 0,
            "exclusiveMinimum": false
          }
        },
        "required": [
          "alertContactId",
          "threshold",
          "recurrence"
        ]
      }
    },
    "lastIncident": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "status": {},
        "cause": {
          "type": "number"
        },
        "reason": {
          "type": "string"
        },
        "startedAt": {
          "oneOf": [
            {},
            {
              "type": "string"
            }
          ]
        },
        "duration": {
          "type": [
            "number",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "status",
        "cause",
        "reason",
        "startedAt",
        "duration"
      ]
    },
    "lastDayUptimes": {
      "type": "object",
      "properties": {
        "bucketSize": {
          "type": "number"
        },
        "totalChanges": {
          "type": "integer",
          "minimum": 0,
          "exclusiveMinimum": false
        },
        "histogram": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "timestamp": {
                "type": "number"
              },
              "uptime": {
                "type": "number",
                "minimum": 0,
                "exclusiveMinimum": false
              },
              "changes": {
                "type": "integer",
                "minimum": 0,
                "exclusiveMinimum": false
              }
            },
            "required": [
              "timestamp",
              "uptime"
            ]
          }
        }
      },
      "required": [
        "bucketSize",
        "histogram"
      ]
    },
    "createDateTime": {
      "oneOf": [
        {},
        {
          "type": "string"
        }
      ]
    },
    "apiKey": {
      "type": [
        "string",
        "null"
      ]
    },
    "groupId": {
      "type": [
        "number",
        "null"
      ]
    },
    "customFields": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "type",
    "interval",
    "sslBrand",
    "sslExpiryDateTime",
    "domainExpireDate",
    "checkSSLErrors",
    "sslExpirationReminder",
    "domainExpirationReminder",
    "followRedirections",
    "authType",
    "customHttpHeaders",
    "httpMethodType",
    "successHttpResponseCodes",
    "timeout",
    "postValueData",
    "postValueType",
    "port",
    "gracePeriod",
    "keywordValue",
    "keywordCaseType",
    "keywordType",
    "responseTimeThreshold",
    "config",
    "regionalData",
    "heartbeatUrl",
    "maintenanceWindows",
    "psps",
    "id",
    "friendlyName",
    "status",
    "url",
    "currentStateDuration",
    "lastIncidentId",
    "userId",
    "tags",
    "assignedAlertContacts",
    "lastDayUptimes",
    "createDateTime",
    "apiKey"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/uptimerobot-monitor-dto"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.