Skip to main content
Get a list of all IPs.
External DocumentationTo learn more, visit the Device 42 documentation.

​
Basic Parameters

ParameterDescription
DeviceThe name of the device to filter the results by.
IPAn IP address to get details on.
IP IDThe ID of the IP to filter the results by.
LimitThe maximum number of objects to return in the response.
OffsetThe pagination offset indicating the starting point for the next set of results.
Subnet IDThe ID of the subnet to filter the results by.
Subnet NameThe name of the subnet to filter the results by.

​
Advanced Parameters

ParameterDescription
AND TagsA comma-separated list of tags to filter by (AND related - return results that include all the tags).
AvailableFilter the results by availability.
Custom Fields (AND)A comma-separated list of custom fields to filter the results by (AND). Format - key1:value1,key2:value2
Custom Fields (OR)A comma-separated list of custom fields to filter the results by (OR). Format - key1:value1,key2:value2
First Added AfterFilter objects first added after or on the given date .
First Added BeforeFilter objects first added before the given date.
Is SharedSelect to include list of shared devices for each IP address.
LabelThe label to filter the results by.
Last Updated AfterFilter objects last updated after or on the given date.
Last Updated BeforeFilter objects last updated before the given date.
MacThe mac address to filter the results by.
TagsA comma-separated list of tags to filter results by (OR filter - return results that include at least one of the tags).
TypeThe type of IP to filter the results by.

​
Example Output

{
	"ips": [
		{
			"available": "no",
			"custom_fields": [
				{
					"key": "test",
					"notes": "",
					"value": ""
				}
			],
			"id": 38,
			"ip": "10.1.10.5",
			"label": "",
			"last_updated": "2015-11-12T17:31:57.985Z",
			"mac_address": "",
			"mac_id": "",
			"notes": "",
			"subnet": "Infra-10.1.10.0/24(Infrastructure Services)",
			"subnet_id": 5,
			"type": "Reserved",
			"is_shared": false,
			"devices": [
				{
					"device_id": 4924,
					"name": "17R0TW1",
					"locked": false
				}
			]
		},
		{
			"available": "no",
			"custom_fields": [
				{
					"key": "test",
					"notes": "",
					"value": ""
				}
			],
			"id": 41,
			"ip": "10.1.20.6",
			"label": "",
			"last_updated": "2017-06-12T17:31:57.985Z",
			"mac_address": "",
			"mac_id": "",
			"notes": "",
			"subnet": "Infra-10.1.20.0/24(Infrastructure Services)",
			"subnet_id": 7,
			"type": "Reserved",
			"is_shared": false,
			"resource": {
				"id": 42,
				"name": "DEFAULT",
				"identifier": "boot/DEFAULT"
			},
			"devices": []
		}
	],
	"limit": 4,
	"offset": 0,
	"total_count": 1004
}

​
Workflow Library Example

List Ips with Device 42 and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop