Documentation is now available for the Fall 2020 Update release!

Get minimal details of resources

This endpoint is used to fetch minimal details of resources.

Leave Feedback

URL

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

Sample URLs

To retrieve all resources with minimal details:

https://{api-url}/https://<api-url>/api/v2/tenants/client_4/resources/minimal

To retrieve specific resources using query variables:

https://{api-url}/api/v2/tenants/client_4/resources/minimal?state=active&locationId=69644&deviceGroupId=1790&deviceTypeId=12

To fetch all cloud resources with IP address

https://{api-url}/api/v2/tenants/client_4/resources/minimal?queryString=ipAddress:12%2BresourceType:CLOUD_PROVIDER

Parameters

FieldDefault Value
locationId = {locationId}0
Use the `Get Time zones` API to fetch location IDs.
deviceGroupId= {deviceGroupId}0
Use the `Get Minimal Details of Device Group` API to fetch device group IDs.
deviceTypeId= {deviceTypeId}0
Use the `Get Device Types` API to fetch device type IDs.
state= {state}active
Supported resource states:
  • active: Indicates managed devices
  • inactive: Indicates unmanaged devices
  • discovered: indicates all discovered devices
  • all: indicates the total device states including active, inactive and discovered
queryString={id, ipAddress, resourceName, hostName, aliasName, resourceType}NA

NA indicates that the value is not applicable.

Query variables

Query VariablesDescription
hostNameName of the host.
dnsNameDomain service name.
resourceNameName of the resource.
aliasNameOther name of resource.
idResource unique ID.
Example: d5bce6fe-d19f-4ad7-8c50-5f639f2dd321
serialNumberResource serial number.
Example: d7bce6fe-d19f-4ad7-8c50-2f639f2dd778
ipAddressResource IP address.
systemUIDSystem Unique ID.
Example: 10.10.10.10
stateResource state supported values: active, inactive, discovered, all. Filter devices based on the device state.
Example: discovered
typeValues accepted as Resource Type:DEVICE, AUTO_SCALING, EBS, LOAD_BALANCER, SQL_DATABASE, SQL_SERVER, SYNTHETIC
Example: DEVICE
deviceTypeFilter 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
resourceTypeFilter resources based on a resource type. Use Get Device Types API to retrieve a list of supported resource types supported by OpsRamp. Enumerate multiple resource types with comma-separated strings.
Example: DEVICE, DOCUMENT_DB
startCreationDateIndicates the date to search the creation date of a resource. Start indicates from date.
Example: 2017-01-01T00:00:00 0000
endCreationDateIndicates the date to search for the last date of resource creation. End indicates to date.
Example: 2017-01-31T00:00:00 0000
startUpdationDateSearch for a resource updated within a specific duration. Start indicates from date.
Example: 2017-01-01T00:00:00 0000
endUpdationDateSearch for a resource updated within a specific duration. End  indicates to date.
Example: 2017-01-31T00:00:00 0000
tagsCustom attribute tag names. Enumerate multiple tags, by separating each tag with a comma.
Example: Admin
templateMonitoring template ID used to retrieve the list of devices assigned on a particular template.
agentProfileAgent profile ID.
gatewayProfileGateway profile ID.
instanceIdCloud instance ID.
accountNumberCloud provider's account number.
Example: 290642135901
installedIntgIdInstalled integration ID.
Example: INTG-6dcbc22c-5436-5eb8-5e7c-8db0319938a4
agentInstalledFilter for agent-installed resources:
  • agentInstalled: true retrieves agent-installed resources.
  • agentInstalled: false retrieves non-agent resources.
Example: true
deviceGroupFetch resources that are part of a specific device/child group. Provide a device group name.
Example: Windows Servers
serviceGroupFetch resources that are part of a specific service group. Provide service group name.
Example: Admin Group
deviceLocationFetch resources that are at a specific location. Provide a location name.
Example: West-SJ
isEqualsTo search for the exact match of a variable.
  • isEquals: true , to search for the exact match of a variable.
  • isEquals: false to search for a similar match of a variable.For example, to fetch list of resources in location West Valley and resource group, provide the query variable respectively as:
    • deviceLocation: West Valley%2BisEquals: true
    • deviceGroup: Windows Servers%2BisEquals:true

Note: This is an optional parameter for deviceGroup/deviceLocation/serviceGroup
assetManagedTimeThe most recent time a resource is managed. The asset managed time gets updated whenever a resource is managed or unmanaged.
Example: 2017-01-01T00:00:00 0000
firstAssetManagedTimeThe first time a resource is managed.
Example: 2017-01-31T00:00:00 0000
appRolesFilter for resources based on applications running on the resources.List of supported applications:
activemqhbasemongodbrabbitmq
apachehdfs-datanodemonitdMemoryStatsredis
cassandrahdfs-namenodemoxi-serverriak
cephiptablemysqlsolr
couchbasejbossnfsiostatspark
couchdbkafkanginxsquid
DNS-Serverkubernetesntptomcat
dockerkvmopenvpnvarnish
docker-containerlighttpdoracleweblogic
elasticsearchmesosmasterpostfixwebsphere
haproxymesosslavepostgresqlzookeeper

Sample response

[{
		"id": "ec9bbd29-b89f-4e6d-ac23-59b81c405cac",
		"name": "Linux Server",
		"hostName": "SJ-Linux",
		"ipAddress": "45.34.23.12",
                "aliasName": "",
		"resourceName": "",
		"resourceType": "Linux"
	},
	{
		"id": "867a8316-8ec2-4e32-b3ec-ce8154856798",
		"name": "3e3cc106-aad5-4b32-9b3d-5079b8fbb2f5",
		"hostName": "",
		"ipAddress": "54.179.70.212",
                "aliasName": "",
		"resourceName": "3e3cc106-aad5-4b32-9b3d-5079b8fbb2f5",
		"resourceType": "ROUTE_53"
	},
	{
		"id": "5df106d1-bebd-4c14-befc-5ac07f5088f8",
		"name": "dc6446ee-9451-44ee-ae8f-8d1e4a0bb0ea",
		"hostName": "",
		"ipAddress": "54.123.234.12",
                "aliasName": "",
		"resourceName": "dc6446ee-9451-44ee-ae8f-8d1e4a0bb0ea",
		"resourceType": "ROUTE_53"
	},
	{
		"id": "0473052b-fed7-4f49-954f-fb22d82f9b52",
		"name": "vcenter",
		"hostName": "",
		"ipAddress": "172.26.105.126",
                "aliasName": "",
		"resourceName": "",
		"resourceType": "CLOUD_PROVIDER"
	}
]