ONoneuptime
Monitor

Get Monitor

Endpoint to retrieve a single Monitor by ID

post/monitor/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Monitor to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "monitoringInterval": true,
    "incomingEmailCustomLocalPart": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "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"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Production API Server",
    "description": "Monitors the health and availability of our main production API server",
    "slug": "example-slug-value",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "isArchived": true,
    "archivedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "archivedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "dependsOnMonitors": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "suppressAlertsWhenParentMonitorStatuses": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "hosts": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "kubernetesClusters": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "dockerHosts": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "podmanHosts": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "proxmoxClusters": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "openStackClouds": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "vmwareVCenters": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "cephClusters": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "storageArrays": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "cloudResources": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "dockerSwarmClusters": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "iotFleets": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "databaseServers": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "services": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "monitorTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "autoProvisionedNetworkDeviceId": "123e4567-e89b-12d3-a456-426614174000",
    "networkAlertPolicyId": "123e4567-e89b-12d3-a456-426614174000",
    "monitorType": "Manual",
    "currentMonitorStatusId": "123e4567-e89b-12d3-a456-426614174000",
    "monitorSteps": {
      "_type": "MonitorSteps",
      "value": {
        "monitorStepsInstanceArray": []
      }
    },
    "monitoringInterval": "*/5 * * * *",
    "customFields": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "isOwnerNotifiedOfResourceCreation": true,
    "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": "123e4567-e89b-12d3-a456-426614174000",
    "incomingRequestSecretKey": "123e4567-e89b-12d3-a456-426614174000",
    "incomingMonitorRequest": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "incomingEmailSecretKey": "123e4567-e89b-12d3-a456-426614174000",
    "incomingEmailCustomLocalPart": "nightly-backups",
    "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.