ONoneuptime
Network Device Discovery Scan

Get Network Device Discovery Scan

Endpoint to retrieve a single Network Device Discovery Scan by ID

post/network-device-discovery-scan/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Network Device Discovery Scan to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "cidr": true,
    "snmpVersion": true,
    "snmpCommunityString": true,
    "snmpV3SecurityLevel": 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",
    "probeId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Router Discovery - Region 1100",
    "cidr": "192.168.1.0/24",
    "snmpConfigs": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "isSnmpEnabled": true,
    "useShortDeviceNames": true,
    "snmpVersion": "V2c",
    "snmpCommunityString": "public",
    "snmpPort": 42,
    "snmpV3SecurityLevel": "authPriv",
    "snmpV3Username": "monitoring",
    "snmpV3AuthProtocol": "SHA",
    "snmpV3AuthKey": "This is an example of longer text content that might be stored in this field.",
    "snmpV3PrivProtocol": "AES",
    "snmpV3PrivKey": "This is an example of longer text content that might be stored in this field.",
    "status": "Pending",
    "statusMessage": "This is an example of longer text content that might be stored in this field.",
    "isNetbiosLookupEnabled": true,
    "discoveredDevices": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "scannedHostCount": 42,
    "respondedHostCount": 42,
    "startedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "completedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "isRecurring": true,
    "rescanIntervalInMinutes": 42,
    "nextScanAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "autoImportProcessedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

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