Network Device Diagnostic

Get Network Device Diagnostic

Endpoint to retrieve a single Network Device Diagnostic by ID

post/network-device-diagnostic/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Network Device Diagnostic to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "diagnosticType": true,
    "hostname": true,
    "status": 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",
    "networkDeviceId": "123e4567-e89b-12d3-a456-426614174000",
    "probeId": "123e4567-e89b-12d3-a456-426614174000",
    "diagnosticType": "Ping",
    "hostname": "10.0.0.1",
    "status": "Pending",
    "statusMessage": "This is an example of longer text content that might be stored in this field.",
    "pingResult": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "traceRouteResult": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "snmpWalkRootOid": "1.3.6.1.2.1.1",
    "snmpWalkAfterOid": "1.3.6.1.2.1.2.2.1.10.12",
    "snmpWalkResult": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "startedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "completedAt": {
      "_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.