List IPs - BlinkOps Documentation

Get a list of all IPs.

External DocumentationTo learn more, visit the Device 42 documentation.

Basic Parameters

Parameter	Description
Device	The name of the device to filter the results by.
IP	An IP address to get details on.
IP ID	The ID of the IP to filter the results by.
Limit	The maximum number of objects to return in the response.
Offset	The pagination offset indicating the starting point for the next set of results.
Subnet ID	The ID of the subnet to filter the results by.
Subnet Name	The name of the subnet to filter the results by.

Advanced Parameters

Parameter	Description
AND Tags	A comma-separated list of tags to filter by (AND related - return results that include all the tags).
Available	Filter 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 After	Filter objects first added after or on the given date .
First Added Before	Filter objects first added before the given date.
Is Shared	Select to include list of shared devices for each IP address.
Label	The label to filter the results by.
Last Updated After	Filter objects last updated after or on the given date.
Last Updated Before	Filter objects last updated before the given date.
Mac	The mac address to filter the results by.
Tags	A comma-separated list of tags to filter results by (OR filter - return results that include at least one of the tags).
Type	The 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
}