--- title: "List Network Device Auto Import Rule" method: POST path: "/network-device-auto-import-rule/get-list" tags: ["Network Device Auto Import Rule"] --- # List Network Device Auto Import Rule `POST /network-device-auto-import-rule/get-list` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/network-device-auto-import-rule/get-list` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to list all Network Device Auto Import Rule items ## Request body - object - `query` NetworkDeviceAutoImportRuleQuerySchema: Query schema for NetworkDeviceAutoImportRule. A field takes a value, which it matches exactly, or an operator its type allows. A relation is filtered by the fields of the record it names, {"": {"": }}, and a resource with owners by who owns it, {"owners": {"_type": "OwnedBy", "userIds": [...], "teamIds": [...]}}. - `_id` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes. - string, uuid - object - `_type` 'EqualTo', required - `value` string, uuid, required - object - `_type` 'NotEqual', required - `value` string, uuid, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, uuid, required - object - `_type` 'Includes', required - `value` string[], required - `createdAt` union: A filter on a Date field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z. - string, date-time - object - `_type` 'EqualTo', required - `value` string, date-time, required - object - `_type` 'NotEqual', required - `value` string, date-time, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, date-time, required - object - `_type` 'GreaterThan', required - `value` string, date-time, required - object - `_type` 'LessThan', required - `value` string, date-time, required - object - `_type` 'GreaterThanOrEqual', required - `value` string, date-time, required - object - `_type` 'LessThanOrEqual', required - `value` string, date-time, required - object - `_type` 'InBetween', required - `startValue` string, date-time, required - `endValue` string, date-time, required - `updatedAt` union: A filter on a Date field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z. - string, date-time - object - `_type` 'EqualTo', required - `value` string, date-time, required - object - `_type` 'NotEqual', required - `value` string, date-time, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, date-time, required - object - `_type` 'GreaterThan', required - `value` string, date-time, required - object - `_type` 'LessThan', required - `value` string, date-time, required - object - `_type` 'GreaterThanOrEqual', required - `value` string, date-time, required - object - `_type` 'LessThanOrEqual', required - `value` string, date-time, required - object - `_type` 'InBetween', required - `startValue` string, date-time, required - `endValue` string, date-time, required - `deletedAt` union: A filter on a Date field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z. - string, date-time - object - `_type` 'EqualTo', required - `value` string, date-time, required - object - `_type` 'NotEqual', required - `value` string, date-time, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, date-time, required - object - `_type` 'GreaterThan', required - `value` string, date-time, required - object - `_type` 'LessThan', required - `value` string, date-time, required - object - `_type` 'GreaterThanOrEqual', required - `value` string, date-time, required - object - `_type` 'LessThanOrEqual', required - `value` string, date-time, required - object - `_type` 'InBetween', required - `startValue` string, date-time, required - `endValue` string, date-time, required - `criteria` union: A filter on a JSON field, by key: {"": {"": }}. A key takes a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. IsNull and NotNull on the field itself ask whether it holds anything. - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `projectId` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes. - string, uuid - object - `_type` 'EqualTo', required - `value` string, uuid, required - object - `_type` 'NotEqual', required - `value` string, uuid, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, uuid, required - object - `_type` 'Includes', required - `value` string[], required - `name` union: A filter on a Text field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes. - string - object - `_type` 'EqualTo', required - `value` string, required - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - object - `_type` 'Includes', required - `value` string[], required - `description` union: A filter on a Long Text field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes. - string - object - `_type` 'EqualTo', required - `value` string, required - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - object - `_type` 'Includes', required - `value` string[], required - `isEnabled` union: A filter on a Boolean field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull. - boolean - object - `_type` 'EqualTo', required - `value` boolean, required - object - `_type` 'NotEqual', required - `value` boolean, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` boolean, required - `ipMatchTarget` union: A filter on a Text field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes. - string - object - `_type` 'EqualTo', required - `value` string, required - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - object - `_type` 'Includes', required - `value` string[], required - `sysNamePattern` union: A filter on a Long Text field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes. - string - object - `_type` 'EqualTo', required - `value` string, required - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - object - `_type` 'Includes', required - `value` string[], required - `sysDescrPattern` union: A filter on a Long Text field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes. - string - object - `_type` 'EqualTo', required - `value` string, required - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - object - `_type` 'Includes', required - `value` string[], required - `sysObjectIdPattern` union: A filter on a Long Text field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes. - string - object - `_type` 'EqualTo', required - `value` string, required - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - object - `_type` 'Includes', required - `value` string[], required - `includePingOnlyHosts` union: A filter on a Boolean field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull. - boolean - object - `_type` 'EqualTo', required - `value` boolean, required - object - `_type` 'NotEqual', required - `value` boolean, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` boolean, required - `pollingIntervalInMinutes` union: A filter on a Number field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween. - number - object - `_type` 'EqualTo', required - `value` number, required - object - `_type` 'NotEqual', required - `value` number, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` number, required - object - `_type` 'GreaterThan', required - `value` number, required - object - `_type` 'LessThan', required - `value` number, required - object - `_type` 'GreaterThanOrEqual', required - `value` number, required - object - `_type` 'LessThanOrEqual', required - `value` number, required - object - `_type` 'InBetween', required - `startValue` number, required - `endValue` number, required - `isExclusion` union: A filter on a Boolean field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull. - boolean - object - `_type` 'EqualTo', required - `value` boolean, required - object - `_type` 'NotEqual', required - `value` boolean, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` boolean, required - `monitorTemplateId` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes. - string, uuid - object - `_type` 'EqualTo', required - `value` string, uuid, required - object - `_type` 'NotEqual', required - `value` string, uuid, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, uuid, required - object - `_type` 'Includes', required - `value` string[], required - `oidTemplateId` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes. - string, uuid - object - `_type` 'EqualTo', required - `value` string, uuid, required - object - `_type` 'NotEqual', required - `value` string, uuid, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, uuid, required - object - `_type` 'Includes', required - `value` string[], required - `createdByUserId` union: A filter on a Object ID field: a value, which it matches exactly, or one of these operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes. - string, uuid - object - `_type` 'EqualTo', required - `value` string, uuid, required - object - `_type` 'NotEqual', required - `value` string, uuid, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'EqualToOrNull', required - `value` string, uuid, required - object - `_type` 'Includes', required - `value` string[], required - `select` NetworkDeviceAutoImportRuleSelectSchema: Select schema for NetworkDeviceAutoImportRule. Set fields to true to include them in the response. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `criteria` boolean - `projectId` boolean - `name` boolean - `description` boolean - `isEnabled` boolean - `ipMatchTarget` boolean - `sysNamePattern` boolean - `sysDescrPattern` boolean - `sysObjectIdPattern` boolean - `includePingOnlyHosts` boolean - `pollingIntervalInMinutes` boolean - `isExclusion` boolean - `monitorTemplateId` boolean - `oidTemplateId` boolean - `createdByUserId` boolean - `sort` NetworkDeviceAutoImportRuleSortSchema: Sort schema for NetworkDeviceAutoImportRule. Only sortable fields are included. - `_id` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `createdAt` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `updatedAt` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `deletedAt` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `projectId` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `name` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `description` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `isEnabled` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `ipMatchTarget` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `sysNamePattern` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `sysDescrPattern` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `sysObjectIdPattern` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `includePingOnlyHosts` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `pollingIntervalInMinutes` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `isExclusion` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `monitorTemplateId` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `oidTemplateId` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `createdByUserId` 'ASC' | 'DESC': The order of a sort: ASC (ascending) or DESC (descending). - `limit` number: Maximum number of items to return. Defaults to 10. - `skip` number: Number of items to skip for pagination. Defaults to 0. ## Response `200` Successful response - object - `data` NetworkDeviceAutoImportRule[] - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `version` number: Object version - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this network device auto import rule. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `description` string: Description of this network device auto import rule. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `isEnabled` boolean, required: Whether this rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `ipMatchTarget` string: Only trigger for discovered hosts whose IP is inside this CIDR (192.168.1.0/24) or octet range (10.16-22.0-255.51-66) — the same notations a scan target takes. Leave empty to match any address. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `sysNamePattern` string: Regex or * wildcard pattern (case-insensitive) matched against the discovered host's SNMP sysName. Leave empty to match any name. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `sysDescrPattern` string: Regex or * wildcard pattern (case-insensitive) matched against the discovered host's SNMP sysDescr. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `sysObjectIdPattern` string: An OID prefix (1.3.6.1.4.1.9) or a '*' wildcard OID pattern with literal dots (1.3.6.1.4.1.9.* for Cisco) matched against the discovered host's SNMP sysObjectID — the vendor's registered enterprise OID. Not regex: dots match dots, so 1.3.6.1.4.1.9.* can never match enterprise 94. Leave empty to match any vendor. Only hosts reported by probes new enough to carry sysObjectID can match. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `includePingOnlyHosts` boolean, required: Also import hosts that answered ping but not SNMP. Off by default: a wrong SNMP credential makes every host on a subnet report as ping-only, and this rule would then import all of them as half-identified devices. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `pollingIntervalInMinutes` number: How often the scan's probe polls each device this rule imports, in minutes: 1, 2, 5, 10, 15, 30 or 60. The probe pings every device and walks the ones that answered SNMP. Leave it empty for the devices' default, every 5 minutes. The same choice as Check every when importing from Review Results. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `isExclusion` boolean, required: Invert this rule: matching hosts are NEVER auto-imported, even when another rule matches them. Use it to carve printers, phones, or other unwanted hosts out of a broader rule. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `monitorTemplateId` string, uuid: ID of the optional Network Device monitor template to apply to devices imported by this rule. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `oidTemplateId` string, uuid: ID of the optional OID Collection Template to link to devices imported by this rule. Permissions - Create: [Project Owner, Project Admin, Create Network Device Auto Import Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [Project Owner, Project Admin, Edit Network Device Auto Import Rule] - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Network Device Auto Import Rule], Update: [No access - you don't have permission for this operation] - `count` number ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)