Retrieve matching network objects by original or canonized name

Retrieve matching network objects based on their original or canonized names.

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

Request Method: POST

Request parameters:

Parameter Data Type Description

collectFqdnData

mandatory

boolean

Determines whether the response will include fully FQDN data for each of the first-level group objects.

  • true: The response will include fully qualified domain name (FQDN) data for each of the first-level group objects.

  • false: The response will not include FQDN data.

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

networkObjectNames

mandatory

array of strings

Network object original or canonized names. Separate multiple values by commas (,).

To get the original and canonized names of a network object, use GET /networkObject/search/findByOriginalNameContaining method from the Network Objects Resource Group.

Canonized name is based on the original name except it uses special characters instead of spaces. For example: - originalName: "object with space", - canonizedName: "object_with_space"

useDeviceGroup

mandatory

boolean

Determines whether the response will include only matching applications configured for the group or global object container or also include device configured applications.

  • - true: The response will include only matching applications configured for the group or global object container.

  • - false: The response will include both applications configured for the group or global object container and device-configured applications.

Request example: 

{
  "collectFqdnData": false,
  "deviceName": "example_device",
  "networkObjectNames": ["object1", "object2"],
  "useDeviceGroup": true
}

cUrl Example: 

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "collectFqdnData": false,
    "deviceName": "example_device",
    "networkObjectNames": ["object1", "object2"],
    "useDeviceGroup": true
  }' \
  https://api.example.com/api/v1/networkObject/search/findByOriginalOrCanonizedName

Status codes:

Code Description
200 OK
400 Bad request

Response parameters:

Parameter Type Description

canonizedName

string

The canonized name of the network object.

classname

string

The classname of the network object.

fqdnObjects

array

An array of FQDN objects associated with the network object.

id

integer

The unique identifier of the FQDN object.

name

string

The domain name\URL of the FQDN object.

icon

string

The icon associated with the network object.

id

integer

The unique identifier of the network object.

invalidNamedObject

boolean

Indicates whether the named object is invalid.

ipCount

integer

The count of IP addresses associated with the network object.

ipType

string

The type of IP address associated with the network object (Null, IPv4, IPv6, mixed).

ipaddress

string

The IP address associated with the network object.

members

string

The members of the network object.

natRanges

array

An array of NAT ranges associated with the network object.

natType

string

The NAT type of the network object (NONE, NAT, STATIC, HIDE).

objectContainer

object

The object container associated with the network object.

brand

object

The brand associated with the object container.

id

integer

The unique identifier of the brand.

name

string

The name of the brand.

containerId

string

The identifier of the object container.

id

integer

The unique identifier of the object container.

objectInternalType

object

The internal type of the network object.

id

integer

The unique identifier of the object internal type.

name

string

The name of the object internal type.

originalName

string

The original name of the network object.

user

string

The user associated with the network object.

zone

string

The zone associated with the network object.

Response example success 200: 

[
  {
    "canonizedName": "object1",
    "classname": "example_class",
    "fqdnObjects": [
      {
        "id": 1,
        "name": "example_fqdn1"
      },
      {
        "id": 2,
        "name": "example_fqdn2"
      }
    ],
    "icon": "example_icon",
    "id": 12345,
    "invalidNamedObject": false,
    "ipCount": 2,
    "ipType": "IPv4",
    "ipaddress": "192.168.0.1",
    "members": "example_member1,example_member2",
    "natRanges": [
      {
        "ipAddress": "10.0.0.1"
      },
      {
        "ipAddress": "10.0.0.2"
      }
    ],
    "natType": "NAT",
    "objectContainer": {
      "brand": {
        "id": 1001,
        "name": "example_brand"
      },
      "containerId": "example_container",
      "id": 9876
    },
    "objectInternalType": {
      "id": 5001,
      "name": "example_internal_type"
    },
    "originalName": "object 1",
    "user": "example_user",
    "zone": "example_zone"
  },
  {
    "canonizedName": "object2",
    "classname": "example_class",
    "fqdnObjects": [],
    "icon": "example_icon",
    "id": 67890,
    "invalidNamedObject": true,
    "ipCount": 0,
    "ipType": "Null",
    "ipaddress": "",
    "members": "",
    "natRanges": [],
    "natType": "NONE",
    "objectContainer": {
      "brand": {
        "id": 1002,
        "name": "example_brand"
      },
      "containerId": "example_container",
      "id": 9876
    },
    "objectInternalType": {
      "id": 5002,
      "name": "example_internal_type"
    },
    "originalName": "object 2",
    "user": "example_user",
    "zone": "example_zone"
  }
]

Response example failure 400: 

{
  "error": "Bad Request"
}