Network Device

Update Network Device

Endpoint to update an existing Network Device

put/network-device/{id}

Request

Path parameters

idstring uuid required

ID of the Network Device to update

Request body

Example request

{
  "data": {
    "name": "Example Text",
    "hostname": "Example Text",
    "isPollingEnabled": true,
    "walkInterfaces": true,
    "collectEndpoints": true,
    "autoApplyVendorHealthTemplate": true,
    "nextPollAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "isArchived": true
  }
}

Response

Updated 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",
    "slug": "example-slug",
    "description": "This is an example of longer text content that provides detailed information.",
    "hostname": "Example Text",
    "dnsName": "This is an example of longer text content that provides detailed information.",
    "otherAddresses": "This is an example of longer text content that provides detailed information.",
    "discoveredName": "Example Text",
    "discoveredNameSource": "Example Text",
    "discoveredDetails": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "macAddress": "Example Text",
    "isMacAddressLearned": true,
    "probe": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "probeId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "site": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "siteId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "oidTemplate": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "oidTemplateId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "snmpCredentialProfile": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "snmpCredentialProfileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "currentMonitorStatus": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "currentMonitorStatusId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "monitoringMethod": "Example Text",
    "deviceRole": "Example Text",
    "networkDeviceRole": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "networkDeviceRoleId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "monitor": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "monitorId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "snmpVersion": "Example Text",
    "snmpCommunityString": "Example Text",
    "snmpPort": 42,
    "snmpV3Auth": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "snmpV3SecurityLevel": "Example Text",
    "snmpV3Username": "Example Text",
    "snmpV3AuthProtocol": "Example Text",
    "snmpV3AuthKey": "This is an example of longer text content that provides detailed information.",
    "snmpV3PrivProtocol": "Example Text",
    "snmpV3PrivKey": "This is an example of longer text content that provides detailed information.",
    "isPollingEnabled": true,
    "pollingIntervalInMinutes": 42,
    "walkInterfaces": true,
    "collectEndpoints": true,
    "snmpOids": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "snmpTables": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "autoApplyVendorHealthTemplate": true,
    "nextPollAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "lastWalkLog": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "sysDescr": "This is an example of longer text content that provides detailed information.",
    "sysName": "Example Text",
    "sysObjectId": "Example Text",
    "sysLocation": "Example Text",
    "sysContact": "Example Text",
    "vendor": "Example Text",
    "deviceModel": "Example Text",
    "serialNumber": "Example Text",
    "firmwareVersion": "Example Text",
    "softwareVersion": "Example Text",
    "lastRebootedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "cdpNeighbors": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "lldpNeighbors": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "snmpTableSnapshot": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "transceiverSnapshot": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "lastSeenAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "lastPolledAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "isReachable": true,
    "isSnmpReachable": true,
    "lastSnmpSeenAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "refreshRequestedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "interfacesTotal": 42,
    "interfacesUp": 42,
    "interfacesDown": 42,
    "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",
    "deletedByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "deletedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "labels": [
      {
        "_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
      },
      {
        "_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
      }
    ]
  }
}

Changes

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