ONoneuptime
Monitor

Create Monitor

Endpoint to create a new Monitor

post/monitor

Request

Request body

Example request

{
  "data": {
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text",
    "monitorType": null
  }
}

Response

Created successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text",
    "description": "This is an example of longer text content that provides detailed information.",
    "slug": "example-slug",
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "isArchived": true,
    "archivedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "archivedByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "archivedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "labels": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "dependsOnMonitors": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "suppressAlertsWhenParentMonitorStatuses": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "hosts": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "kubernetesClusters": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "dockerHosts": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "podmanHosts": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "proxmoxClusters": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "openStackClouds": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "vmwareVCenters": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "cephClusters": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "storageArrays": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "cloudResources": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "dockerSwarmClusters": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "iotFleets": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "databaseServers": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "services": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ],
    "monitorTemplate": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "monitorTemplateId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "autoProvisionedNetworkDevice": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "autoProvisionedNetworkDeviceId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "networkAlertPolicy": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "networkAlertPolicyId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "monitorType": null,
    "currentMonitorStatus": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "currentMonitorStatusId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "monitorSteps": null,
    "monitoringInterval": "Example Text",
    "customFields": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "disableActiveMonitoring": true,
    "incomingRequestMonitorHeartbeatCheckedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "telemetryMonitorNextMonitorAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "telemetryMonitorLastMonitorAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "disableActiveMonitoringBecauseOfScheduledMaintenanceEvent": true,
    "disableActiveMonitoringBecauseOfManualIncident": true,
    "serverMonitorRequestReceivedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "serverMonitorSecretKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "incomingRequestSecretKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "incomingMonitorRequest": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "incomingEmailSecretKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "incomingEmailCustomLocalPart": "Example Text",
    "incomingEmailMonitorLastEmailReceivedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "incomingEmailMonitorRequest": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "incomingEmailMonitorHeartbeatCheckedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "serverMonitorResponse": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "isAllProbesDisconnectedFromThisMonitor": true,
    "isNoProbeEnabledOnThisMonitor": true,
    "minimumProbeAgreement": 42
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.