This is a translation of the original English documentation page. Help us make it better.



integer/array dservice.get(object parameters)

The method allows to retrieve discovered services according to the given parameters.

This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.


(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter Type Description
dserviceids string/array Return only discovered services with the given IDs.
dhostids string/array Return only discovered services that belong to the given discovered hosts.
dcheckids string/array Return only discovered services that have been detected by the given discovery checks.
druleids string/array Return only discovered services that have been detected by the given discovery rules.
selectDRules query Return a drules property with an array of the discovery rules that detected the service.
selectDHosts query Return a dhosts property with an array the discovered hosts that the service belongs to.
selectHosts query Return a hosts property with the hosts with the same IP address and proxy as the service.

Supports count.
limitSelects integer Limits the number of records returned by subselects.

Applies to the following subselects:
selectHosts - result will be sorted by hostid.
sortfield string/array Sort the result by the given properties.

Possible values are: dserviceid, dhostid and ip.
countOutput boolean These parameters being common for all get methods are described in detail in the reference commentary.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(integer/array) Restituisce o:

  • una matrice di oggetti;
  • il conteggio degli oggetti recuperati, se il parametro countOutput è stato usato.


Retrieve services discovered on a host

Retrieve all discovered services detected on discovered host "11".


           "jsonrpc": "2.0",
           "method": "dservice.get",
           "params": {
               "output": "extend",
               "dhostids": "11"
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1


           "jsonrpc": "2.0",
           "result": [
                   "dserviceid": "12",
                   "dhostid": "11",
                   "value": "",
                   "port": "80",
                   "status": "1",
                   "lastup": "0",
                   "lastdown": "1348650607",
                   "dcheckid": "5",
                   "ip": "",
                   "dns": "john.local"
                   "dserviceid": "13",
                   "dhostid": "11",
                   "value": "",
                   "port": "21",
                   "status": "1",
                   "lastup": "0",
                   "lastdown": "1348650610",
                   "dcheckid": "6",
                   "ip": "",
                   "dns": "john.local"
           "id": 1

See also


CDService::get() in ui/include/classes/api/services/CDService.php.