Get Networks Collection - BlinkOps Documentation

Get all IPV4/IPV6 networks for a block, only immediate networks are returned. Important Note: This action is only available when using the V2 connection method of BlueCat Address Manager.

External DocumentationTo learn more, visit the BlueCat Address Manager documentation.

Parameters

Parameter	Description
Block ID	The ID of the networks collection to search the IP within.
Fields	A comma-separated list of fields to include in the response. For example - `id,name,type`.
Filter	A criteria to filter the results by. Use `range` to get the range of IP addresses, for example - `range:'{range}'`.
Include Total Results	Select to get the total number of results in the response.
Limit	The maximum number of results to return per page.
Offset	The pagination offset indicating the starting point for the next set of results.
Order By	The attribute to sort the results with.
Return All Pages	Automatically fetch all resources, page by page.

Example Output

{
	"_links": {
		"next": {
			"href": "/api/v2/networks?offset=2000&limit=1000"
		},
		"prev": {
			"href": "/api/v2/networks?offset=0&limit=1000"
		}
	},
	"count": 0,
	"totalCount": 0,
	"data": [
		{
			"id": 12345,
			"type": "IPv4Network",
			"name": "name",
			"userDefinedFields": {
				"udf1": "value1",
				"udf2": "value2"
			},
			"configuration": {
				"id": 12345,
				"type": "Configuration",
				"name": "name"
			},
			"range": "string",
			"location": {
				"id": 12345,
				"type": "Location",
				"name": "name"
			},
			"gateway": "string",
			"template": {
				"id": 12345,
				"type": "IPv4Template",
				"name": "name"
			},
			"routerPortInfo": "string",
			"defaultView": {
				"id": 12345,
				"type": "View",
				"name": "default"
			},
			"sharedNetworkTag": {
				"id": 12345,
				"type": "Tag",
				"name": "UK Office"
			},
			"duplicateHostnamesAllowed": true,
			"pingBeforeAssignmentEnabled": true,
			"defaultZonesInherited": true,
			"restrictedZonesInherited": true,
			"lowWaterMark": 15,
			"highWaterMark": 95,
			"dynamicUpdateEnabled": true,
			"reverseZoneSigned": true,
			"reverseZoneSigningPolicy": {
				"id": 12345,
				"type": "DNSSECSigningPolicy",
				"name": "name"
			},
			"_inheritedFields": [
				"string"
			],
			"_links": {
				"self": {
					"href": "/networks/12345"
				},
				"collection": {
					"href": "/networks"
				}
			}
		},
		{
			"id": 12345,
			"type": "IPv6Network",
			"name": "name",
			"userDefinedFields": {
				"udf1": "value1",
				"udf2": "value2"
			},
			"configuration": {
				"id": 12345,
				"type": "Configuration",
				"name": "name"
			},
			"range": "string",
			"location": {
				"id": 12345,
				"type": "Location",
				"name": "name"
			},
			"_inheritedFields": [
				"string"
			],
			"_links": {
				"self": {
					"href": "/networks/12345"
				},
				"collection": {
					"href": "/networks"
				}
			}
		}
	]
}

Workflow Library Example

Get Networks Collection with Bluecat Address Manager and Send Results Via Email

Preview this Workflow on desktop