Find Network Objects by Device Name

Get a list of network objects for specified devices.

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

Request Method: GET

Request parameters

Parameter	Type	Description
deviceNames mandatory	array of strings	Device tree names. Separate multiple values with commas (,). Use GET /devices to retrieve tree names.
pageNumber	string	The page number for results (default is 0).
pageSize	string	The number of results per page (default is 50).

cUrl Example

curl -X GET "https://localhost/api/v1/networkObject/search/findByDeviceName?deviceNames=device1,device2&pageNumber=0&pageSize=10" -H "Authorization: Bearer xxx"

Status codes

Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	The session does not have permissions.
404	Not Found
423	Locked
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

Response parameters

Parameter	Type	Description
content	array	List of network objects.
canonizedName	string	The canonicalized name of the network object.
classname	string	The class name of the object.
id	integer	Unique identifier for the network object.
ipaddress	string	IP address associated with the object.
zone	string	Network zone of the object.
fqdnObjects	array	Fully Qualified Domain Name objects. Each entry contains properties such as id and name.
empty	boolean	Indicates if the response is empty.
first	boolean	Indicates if this is the first page.
last	boolean	Indicates if this is the last page.
totalElements	integer	Total number of elements.
totalPages	integer	Total number of pages.

Response example success 200

Copy

{
    "content": [
        {
            "canonizedName": "ip_ForAuto_10.20.110.110",
            "id": 3165395,
            "invalidNamedObject": false,
            "ipaddress": "10.20.110.110",
            "ipCount": 1,
            "ipType": "IPv4",
            "natType": "NONE",
            "objectContainer": {
                "brand": {
                    "id": 2,
                    "name": "CKP"
                },
                "id": 8101,
                "managementDevice": "m_10_20_12_13",
                "name": "m_10_20_12_13",
                "originalName": "m_10_20_12_13"
            },
            "objectInternalType": {
                "id": 0,
                "name": "Device"
            },
            "originalName": "ip_ForAuto_10.20.110.110",
            "zone": ""
        }
    ],
    "empty": false,
    "first": true,
    "last": false,
    "number": 0,
    "numberOfElements": 50,
    "pageable": {
        "offset": 0,
        "paged": true,
        "pageNumber": 0,
        "pageSize": 50,
        "sort": {
            "empty": false,
            "sorted": true,
            "unsorted": false
        },
        "unpaged": false
    },
    "size": 50,
    "sort": {
        "empty": false,
        "sorted": true,
        "unsorted": false
    },
    "totalElements": 98,
    "totalPages": 2
}

Response example failure 400

Copy

{
                "error": "Invalid parameters provided",
                "description": "The parameter 'deviceNames' is missing.",
                "fieldErrors": [
                  {
                    "field": "string",
                    "error": "string"
                  }
                ]
}