Search resources

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/resources/search

Sample URLs

To retrieve all resources of the client:

https://{api-url}/api/v2/tenants/client_16/resources/search

To retrieve specific resources using query variables:

https://{api-url}/api/v2/tenants/msp_1/resources/search?pageNo=1&pageSize=3&queryString=agentInstalled:true%2Bstate:inactive

For this sample, the agent is installed and resources are in inactive state.

Notes

There are special characters that can be used in a query string:

(+) represents the next field and must be URL-encoded.
(:) represents equals. An example is key : value.
Space characters must be URL-encoded.
Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).

Parameters

All parameters are optional:

Field	Default Value
pageNo={pageNo}	1
pageSize={pageSize}	100
isDescendingOrder={true/false}	true
sortName={field}	id
queryString={queryString}	NA
includeStatus={true/false}	false

NA indicates that the value is not applicable.

Query variables

Query Variables

Description

hostName/resourceName

Name of the host.

dnsName

Domain service name.

aliasName

Other name of resource.

Resource unique ID.
Example: d5bce6fe-d19f-4ad7-8c50-5f639f2dd321

serialNumber

Resource serial number.

ipAddress

Resource IP address.

systemUID

System unique ID.

state

Resource state.
Supported values: active, inactive, discovered

type

Resource type. Learn more about the supported resource types.
Example: DEVICE, SQL_SERVER

resourceType

Filter resources based on a resource type. Use Get Device Types API to fetch resource types supported by OpsRamp. Provide multiple resource types with comma-separated strings.
Example: DEVICE, DOCUMENT_DB

deviceType

Filter resources based on device type. This parameter is required if the resource type is a device.Use Get Device Types API to retrieve the names of supported device types. Enumerate multiple device type names with comma-separated strings.
Example: Windows, Linux

appRoles

Filter for applications running on the resources.List of supported applications:

activemq	hbase	mongodb	rabbitmq
apache	hdfs-datanode	monitdMemoryStats	redis
cassandra	hdfs-namenode	moxi-server	riak
ceph	iptable	mysql	solr
couchbase	jboss	nfsiostat	spark
couchdb	kafka	nginx	squid
DNS-Server	kubernetes	ntp	tomcat
docker	kvm	openvpn	varnish
docker-container	lighttpd	oracle	weblogic
elasticsearch	mesosmaster	postfix	websphere
haproxy	mesosslave	postgresql	zookeeper

startCreationDate

Indicates the date to search the creation date of a resource. Start indicates from date.
Example: 2018-01-12T04:53:53 0000

endCreationDate

Indicates the date to search for the last date of resource creation. End indicates to date.
Example: 2018-02-10T10:20:25 0000

startUpdationDate

Search for a resource updated within a specific duration. Start indicates from date.
Example: 2018-01-12T04:53:53 0000

endUpdationDate

Search for a resource updated within a specific duration. End indicates to date.
Example: 2018-02-10T10:20:25 0000

Sample response

{
	"results": [
        {
            "id": "61fec02a-4370-4dfb-be4d-1bb9fe3e05aa",
            "hostName": "TestHost",
            "ipAddress": "1.1.1.2",
            "dns": "",
            "client": {
                "id": 4,
                "uniqueId": "client_4",
                "name": "EHR"
            },
            "createdDate": "2019-05-20T09:31:50+0000",
            "classCode": "device",
            "deviceType": "Desktop",
            "devicePath": "Desktop",
            "type": "DEVICE",
            "state": "active",
            "make": "",
            "model": "",
            "osName": "",
            "description": "test dummy device",
            "gatewayProfileId": "0",
            "source": "MANUAL",
            "agentInstalled": false,
            "attributes": {
                "network": [
			{
                        "ip": "172.24.133.91",
                        "mac": "f8:94:c2:0c:10:f2",
                        "aliasIp": "172.24.133.100, 172.24.133.101"
                    }
		]
            },
            "aliasName": "TestAlias",
            "name": "TestHost",
            "resourceName": "TestResource",
            "consoles": [],
            "resourceType": "Desktop",
            "assetManagedTime": "2019-05-20T09:31:50+0000",
            "firstAssetManagedTime": "2019-05-20T09:31:50+0000",
            "deleted": false,
            "ts": 0,
            "clientId": 0,
            "locationOffset": 0,
            "totalLocations": 0,
        }
    ],
    "totalResults": 1,
    "orderBy": "name",
    "pageNo": 1,
    "pageSize": 100,
    "totalPages": 1,
    "nextPage": false,
    "descendingOrder": false
}