--- title: "Create Monitor" method: POST path: "/monitor" tags: ["Monitor"] --- # Create Monitor `POST /monitor` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/monitor` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to create a new Monitor ## Request body - object - `data` MonitorCreateSchema, required: Create schema for Monitor model. Create - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `name` string, required: Any friendly name for this monitor. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `isArchived` boolean: Archived monitors are hidden from monitor lists and status pages, are not checked, and open no incidents or alerts. Unarchiving resumes monitoring. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `labels` object[]: Labels to group and filter by. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `dependsOnMonitors` object[]: Parent monitors this monitor depends on. When a parent is offline (or in one of the configured suppression statuses), alerts and incidents from this monitor are suppressed at creation time — the monitor keeps evaluating and its status timeline still updates. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `suppressAlertsWhenParentMonitorStatuses` object[]: Parent monitor statuses that suppress this monitor's alerts and incidents. When empty, statuses flagged as offline suppress (the default). Only used when Depends On Monitors is set. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `hosts` object[]: Hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `kubernetesClusters` object[]: Kubernetes clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `dockerHosts` object[]: Docker hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `podmanHosts` object[]: Podman hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `proxmoxClusters` object[]: Proxmox clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `openStackClouds` object[]: OpenStack clouds this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `vmwareVCenters` object[]: VMware vCenters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `cephClusters` object[]: Ceph clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `storageArrays` object[]: Storage arrays this monitor watches. Incidents and alerts it creates are linked to them. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `cloudResources` object[]: Cloud resources this monitor watches. Incidents and alerts it creates are linked to them. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `dockerSwarmClusters` object[]: Docker Swarm clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `iotFleets` object[]: IoT fleets this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `databaseServers` object[]: Databases this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `services` object[]: Services this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `monitorTemplateId` string, uuid: ID of the Monitor Template this monitor was created from. Null for monitors not created from a template. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `monitorType` 'Manual' | 'Website' | 'API' | 'Ping' | 'Kubernetes' | 'Docker' | 'Host' | 'Podman' | 'Docker Swarm' | 'Proxmox' | 'OpenStack' | 'VMware' | 'Ceph' | 'Storage Array' | 'IoT Device' | 'IP' | 'Incoming Request' | 'Incoming Email' | 'Port' | 'Server' | 'SSL Certificate' | 'SQL Query' | 'Database' | 'Synthetic Monitor' | 'Custom JavaScript Code' | 'Logs' | 'Metrics' | 'Traces' | 'Exceptions' | 'Profiles' | 'Security Events' | 'AI / LLM' | 'Network Device' | 'DNS' | 'DNSSEC' | 'NTP' | 'Domain' | 'External Status Page' | 'Probe Status', required: What is the type of this monitor? Website? API? etc. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `currentMonitorStatusId` string, uuid: Whats the current status ID of this monitor? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `monitorSteps` object: What would you like to monitor and what is the criteria? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `monitoringInterval` string: How often would you like OneUptime to monitor this resource? A 5-field cron expression, not a label: "*/5 * * * *" is every five minutes. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `customFields` object: Custom Fields on this resource. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `disableActiveMonitoring` boolean: Disable active monitoring for this resource? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `incomingRequestMonitorHeartbeatCheckedAt` object: This field is for Incoming Request monitor only. When was the last time we checked the heartbeat? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `telemetryMonitorNextMonitorAt` object: This field is for Telemetry Monitor only. When is the next time we should monitor? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `telemetryMonitorLastMonitorAt` object: This field is for Telemetry Monitor only. When was the last time we monitored? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `serverMonitorRequestReceivedAt` object: This field is for Server Monitor only. When was the last time we received a request? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `incomingMonitorRequest` object: Incoming Monitor Request for Incoming Request Monitor. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `serverMonitorResponse` object: Server Monitor Response for Server Monitor. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `minimumProbeAgreement` number: Minimum number of probes that must agree on a status before the monitor status changes. If null, all enabled and connected probes must agree. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] ## Response `201` Created successfully - object - `data` MonitorReadSchema: Read schema for Monitor model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `name` string, required: Any friendly name for this monitor. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `slug` string: Friendly globally unique name for your object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `isArchived` boolean: Archived monitors are hidden from monitor lists and status pages, are not checked, and open no incidents or alerts. Unarchiving resumes monitoring. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `archivedAt` object: When this monitor was archived. Empty while it is not archived. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `archivedByUserId` string, uuid: User ID who archived this object (if this object was archived by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `labels` object[]: Labels to group and filter by. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `dependsOnMonitors` object[]: Parent monitors this monitor depends on. When a parent is offline (or in one of the configured suppression statuses), alerts and incidents from this monitor are suppressed at creation time — the monitor keeps evaluating and its status timeline still updates. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `suppressAlertsWhenParentMonitorStatuses` object[]: Parent monitor statuses that suppress this monitor's alerts and incidents. When empty, statuses flagged as offline suppress (the default). Only used when Depends On Monitors is set. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `hosts` object[]: Hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `kubernetesClusters` object[]: Kubernetes clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `dockerHosts` object[]: Docker hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `podmanHosts` object[]: Podman hosts this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `proxmoxClusters` object[]: Proxmox clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `openStackClouds` object[]: OpenStack clouds this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `vmwareVCenters` object[]: VMware vCenters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `cephClusters` object[]: Ceph clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `storageArrays` object[]: Storage arrays this monitor watches. Incidents and alerts it creates are linked to them. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `cloudResources` object[]: Cloud resources this monitor watches. Incidents and alerts it creates are linked to them. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `dockerSwarmClusters` object[]: Docker Swarm clusters this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `iotFleets` object[]: IoT fleets this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `databaseServers` object[]: Databases this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `services` object[]: Services this monitor watches. Incidents and alerts it creates are linked to them, so OneUptime AI can investigate and fix them there. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `id` string - `monitorTemplateId` string, uuid: ID of the Monitor Template this monitor was created from. Null for monitors not created from a template. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `autoProvisionedNetworkDeviceId` string, uuid: ID of the Network Device that caused this monitor to be provisioned automatically. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `networkAlertPolicyId` string, uuid: ID of the Network Alert Policy that provisioned this monitor, when one did. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `monitorType` 'Manual' | 'Website' | 'API' | 'Ping' | 'Kubernetes' | 'Docker' | 'Host' | 'Podman' | 'Docker Swarm' | 'Proxmox' | 'OpenStack' | 'VMware' | 'Ceph' | 'Storage Array' | 'IoT Device' | 'IP' | 'Incoming Request' | 'Incoming Email' | 'Port' | 'Server' | 'SSL Certificate' | 'SQL Query' | 'Database' | 'Synthetic Monitor' | 'Custom JavaScript Code' | 'Logs' | 'Metrics' | 'Traces' | 'Exceptions' | 'Profiles' | 'Security Events' | 'AI / LLM' | 'Network Device' | 'DNS' | 'DNSSEC' | 'NTP' | 'Domain' | 'External Status Page' | 'Probe Status', required: What is the type of this monitor? Website? API? etc. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `currentMonitorStatusId` string, uuid: Whats the current status ID of this monitor? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `monitorSteps` object: What would you like to monitor and what is the criteria? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `monitoringInterval` string: How often would you like OneUptime to monitor this resource? A 5-field cron expression, not a label: "*/5 * * * *" is every five minutes. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `customFields` object: Custom Fields on this resource. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `disableActiveMonitoring` boolean: Disable active monitoring for this resource? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `incomingRequestMonitorHeartbeatCheckedAt` object: This field is for Incoming Request monitor only. When was the last time we checked the heartbeat? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `telemetryMonitorNextMonitorAt` object: This field is for Telemetry Monitor only. When is the next time we should monitor? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `telemetryMonitorLastMonitorAt` object: This field is for Telemetry Monitor only. When was the last time we monitored? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `disableActiveMonitoringBecauseOfScheduledMaintenanceEvent` boolean: Disable Monitoring because of Ongoing Scheduled Maintenance Event. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `disableActiveMonitoringBecauseOfManualIncident` boolean: Disable Monitoring because of Incident which is creeated manually by user. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `serverMonitorRequestReceivedAt` object: This field is for Server Monitor only. When was the last time we received a request? Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `serverMonitorSecretKey` string, uuid: This field is for Server Monitor only. Secret Key to authenticate the request. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `incomingRequestSecretKey` string, uuid: This field is for Incoming Request Monitor only. Secret Key to authenticate the request. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `incomingMonitorRequest` object: Incoming Monitor Request for Incoming Request Monitor. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `incomingEmailSecretKey` string, uuid: This field is for Incoming Email Monitor only. Secret Key used to generate unique email address. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `incomingEmailCustomLocalPart` string: This field is for Incoming Email Monitor only. A custom name for this monitor's inbound email address: the part before the @, on the server's inbound email domain. While set, it replaces the generated monitor-{secret key} address. Must be unique across all monitors. Set to null to go back to the generated address. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] - `incomingEmailMonitorLastEmailReceivedAt` object: This field is for Incoming Email Monitor only. When was the last email received? Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `incomingEmailMonitorRequest` object: This field is for Incoming Email Monitor only. Last email data received. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `incomingEmailMonitorHeartbeatCheckedAt` object: This field is for Incoming Email monitor only. When was the last time we checked the heartbeat? Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `serverMonitorResponse` object: Server Monitor Response for Server Monitor. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `isAllProbesDisconnectedFromThisMonitor` boolean: All Probes Disconnected From This Monitor. Is this monitor not being monitored? Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `isNoProbeEnabledOnThisMonitor` boolean: No Probe Enabled On This Monitor. Is this monitor not being monitored? Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [No access - you don't have permission for this operation] - `minimumProbeAgreement` number: Minimum number of probes that must agree on a status before the monitor status changes. If null, all enabled and connected probes must agree. Permissions - Create: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Create Monitor], Read: [Project Owner, Project Admin, Project Member, Viewer, Monitor Admin, Monitor Member, Monitor Viewer, Read Monitor], Update: [Project Owner, Project Admin, Project Member, Monitor Admin, Monitor Member, Edit Monitor] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)