Get resource

This endpoint is used to retrieve information, and optional details of a device, of a specific resource.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{clientId}/resources/{resourceId}

Sample URLs

To retrieve resource details:

https://{api-url}/api/v2/tenants/client_4/resources/28139457-597f-44ac-a261-fac49707b850

To retrieve device details:

https://{api-url}/api/v2/tenants/client_16/resources/4f7f63a0-c7a3-4f2a-89de-74ff5eecb805

Sample responses

Response of a resource:

{
    "id": "46646d0b-976f-46ed-b47b-40178f5b0508",
    "ipAddress": "172.31.20.84",
    "extResourceId" : "67034",
    "state": "active",
    "source": "MANUAL",
    "agentInstalled": false,
    "status": "UP",
    "location": {
        "id": 516,
        "name": "us-east-1a",
        "clientId": 10,
        "mspId": 3,
        "city": "N.Virginia"
    },
    "components": [
        "disks"
    ],
    "tags": [
        {
            "name": "test",
            "value": "testValue",
            "tagSource": "OPSRAMP"
        }
    ],
    "bios": {
        "systemSerial": "",
        "systemModel": "c1.medium"
    },
    "cpus": [],
    "generalInfo": {
        "name": "Test Device1",
        "osName": "",
        "make": "",
        "description": "",
        "hostName": "Test Device1",
        "dns": "",
        "resourceType": "Linux",
        "keyboardType": "US104",
        "encodingType": "UTF8",
        "physicalMemory": "0.0",
        "resourceName": "",
        "aliasName": "",
        "createdTime": "2016-06-30T15:24:40+0000",
        "updatedTime": "2016-06-30T15:25:00+0000",
        "agentDeploytime": "2016-06-30T15:24:40+0000",
        "assetManagedTime": "",
        "firstAssetManagedTime": ""
    },
    "consoles": [],
    "networkCardDetails": [
        {
            "id": 1,
            "networkName": "wlp2s0",
            "status": "Up",
            "ipAddress": "172.24.133.91",
            "macAddress": "f8:94:c2:0c:10:f2",
            "dhcpEnabled": false,
            "linkMode": "MGNT_MODE_LINK",
            "aliasIps": "172.24.133.100, 172.24.133.101"
        }
      ],
    "installedApp": {
        "id": "INTG-0d249a09-32a5-4703-b5c9-1475456f2011",
        "displayName": "AWS_INTG",
        "integration": {
            "id": "AWS",
            "name": "AWS"
        }
    },
    "properties": {
        "provider": "AWS",
        "instanceId": "i-0eff82b84a8037c2d",
        "instanceState": "running",
        "instanceType": "c1.medium",
        "publicIp": "34.202.160.29",
        "ami": "ami-021800badbd6a2e64",
        "launchDate": "2018-12-12T05:37:09+0000",
        "owner": "371067416711",
        "privateDns": "ip-172-31-20-84.ec2.internal",
        "privateIp": "172.31.20.84",
        "zone": "us-east-1a",
        "monitoringState": "disabled"
    },
    "metricTypes": [
        {
            "metricName": "resource.availability",
            "displayName": "Availability",
            "unit": "COUNTER",
            "availabilityMetric": false,
            "thresholdType": "STATIC"
        }
    ],
    "clientUniqueId": "client_10",
    "appRoles": [
        {
            "name": "cassandra"
        },
        {
            "name": "hbase"
        },
        {
            "name": "hdfs-namenode"
        }
    ],
    "wsusSettings": "disabled"
}

Response of a device:

{
	"id": "4f7f63a0-c7a3-4f2a-89de-74ff5eecb805",
	"createdDate": "2018-05-03T06:29:38+0000",
	"updatedDate": "2018-05-04T10:20:30+0000",
	"type": "EBS",
	"state": "active",
	"source": "MANUAL",
	"status": "UP",
	"location": {
		"id": 0,
		"name": "East US"
	},
	"resourceName": "SJ-Host",
	"consoles": [],
	"clientUniqueId": "client_16"
}

Response of a synthetic resource:

{
    "id": "ed74701d-7f41-4fd1-861e-513647051734",
    "resourceType" : "SYNTHETIC",
    "name": "Google Monitor",
    "consoles": [],
    "checkType": "HTTP",
    "host": "www.google.com",
    "deleted": false,
    "url": "www.google.com",
    "credential": {
        "id": 0,
        "secure": false,
        "port": 0,
        "snmpVersion": "V2",
        "autoEnableMode": false,
        "universal": true,
        "spSecure": false,
        "spPort": 0,
        "securityLevel": "oAuth2",
        "timeoutMs": 0,
        "oauthClientKey": "kHSageRP9CTeCFP7Wfrzzc45pFJZ99N4",
        "oauthClientSecret": "5w6rKEAgYpsYDdd8vm5PnUMsQWqTnh423FArQYxGW6V3zqDcTG2z7UvjV3YBMq9Y",
        "oauthAccessTokenUrl": "auth/oauth/token",
        "oauthGrantType": "client_credentials"
    },
    "locationUuids": [
        "7b77f37f-5eb0-4ec2-bd19-15cc6853e3ca"
    ],
    "ts": 1551175570000,
    "clientId": 5,
    "locationOffset": 0,
    "totalLocations": 0
}