Retrieve Network Objects Containing All FQDNs

Allows you to retrieve a list of all network objects that contain all the requested FQDNs (exact match).

Resource name: /api/v1/networkObject/search/containingAllFqdns

Request method: POST

Request parameters:

Parameter Type Description

deviceName

mandatory

string

Tree name of the device.

(To get the entity name for a device or group, see Device names in the ASMS APIs

fqdns

mandatory

array of strings List of FQDNs.

useDeviceGroup

mandatory

boolean

Determines whether the response includes only applications configured for the group, or globally, or also includes applications specifically configured for the device.

  • true: Response includes only applications configured for the group, or globally.

  • false: response also includes applications specifically configured for the device.

Request example: 

{
  "deviceName": "exampleDevice",
  "fqdns": ["example.com", "test.com"],
  "useDeviceGroup": true
}

cUrl Example: 

curl -X POST "https://<localhost>/api/v1/networkObject/search/containingAllFqdns" -H "Content-Type: application/json" -d '{"deviceName": "exampleDevice", "fqdns": ["example.com", "test.com"], "useDeviceGroup": true}'

Status codes:

Code Description
200 OK
400 Bad Request

Response parameters:

Parameter Data Type Description

networkObjects

array

List of Network Objects

canonizedName

string

Canonical Name

classname

string

Class Name

fqdnObjects

array

List of FQDN Objects

id

integer

FQDN Object ID

name

string

FQDN Object Name

icon

string

Icon

id

integer

Network Object ID

invalidNamedObject

boolean

Invalid Named Object flag

ipCount

integer

IP Count

ipType

string

IP Type (Null, IPv4, IPv6, mixed)

ipaddress

string

IP Address

members

string

Members

natRanges

array

List of Network Object NAT Ranges

ipAddress

string

IP Address

natType

string

NAT Type (NONE, NAT, STATIC, HIDE)

objectContainer

object

Object Container

brand

object

Brand

id

integer

Brand ID

name

string

Brand Name

containerId

string

Container ID

id

integer

Object Container ID

managementDevice

string

Management Device

name

string

Object Container Name

originalName

string

Object Container Original Name

objectInternalType

object

Object Internal Type

id

integer

Object Internal Type ID

name

string

Object Internal Type Name

originalName

string

Network Object Original Name

user

string

User

zone

string

Zone

 

Response example success 200: 

{
  "networkObjects": [
    {
      "canonizedName": "group1-network_objects",
      "classname": "domain",
      "fqdnObjects": [],
      "icon": "icon_name",
      "id": 1001,
      "invalidNamedObject": false,
      "ipCount": 2,
      "ipType": "IPv4",
      "ipaddress": "192.168.1.1",
      "members": "example.com,test.com",
      "natRanges": [
        {
          "ipAddress": "192.168.1.2"
        }
      ],
      "natType": "STATIC",
      "objectContainer": {
        "brand": {
          "id": 2001,
          "name": "Brand A"
        },
        "containerId": "container_id_1",
        "id": 3001,
        "managementDevice": "device_name",
        "name": "Object Container 1",
        "originalName": "Original Object Container 1"
      },
      "objectInternalType": {
        "id": 4001,
        "name": "Dynamic"
      },
      "originalName": "group1-network_objects",
      "user": "user1",
      "zone": "zone1"
    }
  ]
}

Response example failure 400: 

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request parameters",
  "details": [
    {
      "field": "deviceName",
      "message": "Device name is required"
    },
    {
      "field": "fqdns",
      "message": "At least one FQDN is required"
    }
  ]
}