Search for devices based on searching criteria. The following permissions are required to run this action:
  • Devices > Read

​
Parameters

ParameterDescription
Device IDThe ID of the Armis device to search for.
FieldsA comma-separated list of fields to include in the response.
IP AddressThe IPv4 or IPv6 address of the devices to search for.
MAC AddressThe MAC address of the devices to search for.
Page SizeThe maximum number of results to return per request.
Return All PagesAutomatically fetch all resources, page by page.
SearchA query string to search records by.
Starting IndexThe index of the first result to return, used for pagination.
TagThe tag of the devices to search for.

​
Example Output

{
	"data": {
		"count": 1,
		"data": [
			{
				"accessSwitch": null,
				"boundaries": "test1, tag_boundary, test2",
				"businessImpact": "Unassigned",
				"category": "Handhelds",
				"customProperties": {},
				"dataSources": [
					{
						"firstSeen": "2022-09-05T12:48:41.074628+00:00",
						"lastSeen": "2023-10-19T07:31:14+00:00",
						"name": "API",
						"types": [
							"Data Upload"
						]
					},
					{
						"firstSeen": "2021-07-04T06:40:35.166307+00:00",
						"lastSeen": "2023-10-19T07:31:14+00:00",
						"name": "Armis Smart Scanner",
						"types": [
							"Vulnerability Management"
						]
					}
				],
				"firstSeen": "2021-03-25T09:27:29.286706+00:00",
				"id": 1,
				"ipAddress": "10.202.0.122, 1.1.1.1",
				"ipv6": [
					"fe80:3::1ff:fe23:4567:890a",
					"2600:4040:f015:e900:5160:5160:4f0:acd2:1ac7"
				],
				"lastSeen": "2023-10-19T07:31:14+00:00",
				"macAddress": "00:0C:29:6D:36:75, AA:AA:AA:AA:AA:AA",
				"manufacturer": "Apple",
				"model": "iPhone 6S",
				"name": "mike's iphone",
				"names": "mike's iphone,333,222,111",
				"operatingSystem": "iOS",
				"operatingSystemVersion": "10.3.1",
				"purdueLevel": 4,
				"riskLevel": 10,
				"sensor": {
					"name": "API",
					"type": "API"
				},
				"site": {
					"location": "Ney York, yefet 16",
					"name": "New York"
				},
				"tags": [
					"ip connection online 151",
					"tag activity offline",
					"tag ip connection online",
					"66666"
				],
				"type": "Mobile Phones",
				"userIds": [
					67581
				],
				"visibility": "Full"
			}
		],
		"next": null,
		"prev": null,
		"total": 1
	},
	"success": true
}

​
Workflow Library Example

Search Devices with Armis Centrix and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop