Search Resources

Gets the resources of tenant(s). Default search list all the managed resources which may not be same as UI listing.

Query string should be valid input values

  • Eg 1: state values are enum: active/inactive "queryString=state:active" or "queryString=state:inactive"
  • Eg 2: we should allow only above listed variables
    • Valid: "queryString=hostName:abc"
    • Invalid: "queryString=hostName2:abc"
  • Eg 3: We should give both variable name and value
    • Valid: "queryString=hostName:abc"
    • Invalid: "queryString=hostName"

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or partnerId of the tenant

Query Parameters

  • pageNointeger

    Page no.

    Default: 1

  • pageSizeinteger

    Page size.

    Default: 100

  • isDescendingOrderboolean

    Is Descending order.

  • sortNamestring

    Sort order field.

    Default: id

  • queryStringstring

    Prepared query string consists of query parameters.

  • includeStatusboolean

  • hostNamestring

    Name of the host.

  • dnsNamestring

    Domain service name.

  • resourceNamestring

    Name of the resource.

  • aliasNamestring

    Other name of resource.

  • idstring

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

  • serialNumberstring

    Resource serial number.Example: d7bce6fe-d19f-4ad7-8c50-2f639f2dd778

  • ipAddressstring

    Resource IP address.

  • systemUIDstring

    System Unique ID.Example:

  • statestring

    Resource state supported values: active, inactive, discovered, all. Filter devices based on the device state.Example: discovered

  • typestring


  • deviceTypestring

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

  • resourceTypestring

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

  • startCreationDatestring

    Indicates the date to search the creation date of a resource. Start indicates from date.Example: 2017-01-01T00:00:00 0000

  • endCreationDatestring

    Indicates the date to search for the last date of resource creation. End indicates to date.Example: 2017-01-31T00:00:00 0000

  • startUpdationDatestring

    Search for a resource updated within a specific duration. Start indicates from date.Example: 2017-01-01T00:00:00 0000|

  • endUpdationDatestring

    Search for a resource updated within a specific duration. End indicates to date.Example: 2017-01-31T00:00:00 0000

  • tagsstring

    Custom attribute tag names. Enumerate multiple tags, by separating each tag with a comma.Example: Admin

  • templatestring

    Monitoring template ID used to get the list of devices assigned on a particular template.

  • agentProfilestring

    Agent profile ID.

  • gatewayProfilestring

    Gateway profile ID.

  • instanceIdstring

    Cloud instance ID.

  • accountNumberstring

    Cloud provider's account number.Example: 290642135901

  • agentInstalledboolean

    Filter for agent-installed resources: agentInstalled: true gets agent-installed resources.- agentInstalled: false gets non-agent resources.Example: true

  • deviceGroupstring

    Fetch resources that are part of a specific device/child group. Provide a device group name.Example: Windows Servers

  • serviceGroupstring

    Fetch resources that are part of a specific service group. Provide service group name.Example: Admin Group

  • deviceLocationstring

    Fetch resources that are at a specific location. Provide a location name.Example: West-SJ

  • isEqualsstring

    To 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

  • assetManagedTimestring

    The 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

  • firstAssetManagedTimestring

    The first time a resource is managed.Example: 2017-01-31T00:00:00 0000

  • aliasIpstring

    Alias IP address of the network you have.

  • appRolesstring

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

  • osArchitecturestring

    Filter for supported architecture 32 bit or 64 bit.


  • resultsarray

  • totalResultsinteger

  • orderBystring

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • descendingOrderboolean

Loading Examples...