Search Object (Control Center)

Search for one or more objects for the given input filter.

URL: /adc-objects-search

Type: POST

Parameter

Param Type Name Description Field Type
Header sessionId ** Session Id received after login string
Query gwkey Tenant Key. Needed only in case of multitenant installations string
Query gwsource** Source from which the request is triggered (Eg: web, external) String
Payload input**

Input filter key and value to perform the search. Multiple key and value pairs can also be mentioned. Supported keys :

  • deviceName
  • objectType
  • vendor
  • destinationIp
  • destinationPort
  • partition
  • connections
  • ip
 Key:value
Payload Filter

start: start index of the response to the display. The default value is taken as 1.

max: number of entries from a start index to display. The default value is taken as 100.

sortColumn : Sort by column

sortOrder: Sorting order (asc/desc)

** - Mandatory value

Possible Response Message and Code

HTTP Code Description Response Message
400 Bad request Invalid search input
200 OK Matching results found for the given input
200 OK No matching results found