Endpoint
/api/v2/tenants/{tenantId}/resources/{resourceId}

Deletes a resource using the resource ID.

Path Parameters
tenantId
string

Describes the client ID of the tenant

resourceId
string

Responses

OK

Endpoint
/api/v2/tenants/{tenantId}/resources/{resourceId}

Gets information and optional device details for a specific resource.

Path Parameters
tenantId
string

Describes the client ID of the tenant

resourceId
string

Responses

OK

aliasName
string

appRoles
array

appRoles.name
bios
object

bios.biosVersion
bios.systemManufacturer
bios.systemModel
bios.systemSerial
checkType
string

clientId
number

clientUniqueId
string

cloudInstance
boolean

components
array

consoles
array

cpus
array

cpus.dataWidth
cpus.l2CacheSize
cpus.manufacturer
cpus.maxClockSpeed
cpus.numberOfCores
cpus.powerManagementSupported
cpus.processor
cpus.processorName
createdDate
string

credential
object

credential.oauthAccessTokenUrl
credential.oauthClientKey
credential.oauthClientSecret
credential.oauthGrantType
credential.password
credential.securityLevel
credential.userName
credentials
array

credentials.credentialType
credentials.password
credentials.securityLevel
credentials.userName
deleted
boolean

device
boolean

discoveryProfile
object

discoveryProfile.id
discoveryProfile.name
discoveryProfile.scanNow
encrypted
boolean

excludeIndexing
boolean

frequency
number

generalInfo
object

generalInfo.aliasName
generalInfo.assetManagedTime
generalInfo.createdTime
generalInfo.dns
generalInfo.domainRole
generalInfo.encodingType
generalInfo.firstAssetManagedTime
generalInfo.hostName
generalInfo.keyboardType
generalInfo.macAddress
generalInfo.make
generalInfo.managementGatewayProfileName
generalInfo.name
generalInfo.osName
generalInfo.osVersion
generalInfo.physicalMemory
generalInfo.resourceName
generalInfo.resourcePath
generalInfo.resourceType
generalInfo.updatedTime
host
string

hostName
string

id
string

identity
string

installedApp
object

installedApp.displayName
installedApp.id
installedApp.installedBy
installedApp.installedTime
installedApp.integration
installedApp.status
ipAddress
string

location
object

location.city
location.clientId
location.id
location.mspId
location.name
locationOffset
number

locationUuids
array

managementProfile
object

managementProfile.description
managementProfile.id
managementProfile.name
managementProfile.type
metricTypes
array

metricTypes.availabilityMetric
metricTypes.displayByComponent
metricTypes.displayName
metricTypes.displayOrder
metricTypes.factor
metricTypes.id
metricTypes.metricName
metricTypes.tenantId
metricTypes.thresholdType
metricTypes.timeSeries
metricTypes.topMetric
metricTypes.unit
metricTypes.version
name
string

networkCardDetails
array

networkCardDetails.adminStatus
networkCardDetails.confLinkSpeed
networkCardDetails.dhcpEnabled
networkCardDetails.id
networkCardDetails.ifAlias
networkCardDetails.ifDescription
networkCardDetails.ifName
networkCardDetails.ifTxType
networkCardDetails.ifType
networkCardDetails.ipAddress
networkCardDetails.linkMode
networkCardDetails.macAddress
networkCardDetails.networkName
networkCardDetails.operationalStatus
networkCardDetails.speed
networkCardDetails.status
paused
boolean

port
number

properties
object

properties.arn
properties.ftmMode
properties.licenceData
properties.perfLevelInfo
properties.physical_location_name
properties.policy
properties.provider
properties.uniqueId
properties.vMotion
properties.zone
receiverHostPort
number

resourceName
string

resourceType
string

saId
number

source
string

state
string

status
string

tags
array

tags.name
tags.tagSource
tags.value
timeout
number

topologyEnabled
boolean

totalLocations
number

ts
number

type
string

updatedDate
string

validateSSL
boolean

{
  "aliasName": "",
  "clientId": 0,
  "clientUniqueId": "client_809322",
  "consoles": [],
  "createdDate": "2021-04-26T11:02:55+0000",
  "deleted": false,
  "encrypted": false,
  "frequency": 0,
  "hostName": "",
  "id": "4a74dc3b-807a-430c-a877-613acd78d195",
  "identity": "arn:aws:events:us-east-1:095202543984:event-bus/default",
  "installedApp": {
    "displayName": "AWS-ExternalId-API",
    "id": "INTG-e5084c50-cfbc-4619-be4d-248884b26481",
    "installedBy": "opsramp_api_user",
    "installedTime": "2021-04-26T11:17:15+0100",
    "integration": {
      "id": "AWS",
      "multipleInstallations": true,
      "name": "AWS"
    },
    "status": "enabled"
  },
  "ipAddress": "",
  "location": {
    "id": 0,
    "name": "us-east-1"
  },
  "locationOffset": 0,
  "name": "default",
  "paused": false,
  "port": 0,
  "properties": {
    "arn": "arn:aws:events:us-east-1:095202543984:event-bus/default",
    "policy": null,
    "provider": "AWS",
    "uniqueId": "3946ba4a-d5f9-4e5b-b977-e0f4085ff43a",
    "zone": "us-east-1"
  },
  "receiverHostPort": 0,
  "resourceName": "default",
  "resourceType": "AWS_EVENT_BRIDGE_BUS",
  "source": "PUBLICCLOUD",
  "state": "active",
  "status": "UNKNOWN",
  "timeout": 0,
  "topologyEnabled": false,
  "totalLocations": 0,
  "ts": 0,
  "type": "AWS_EVENT_BRIDGE_BUS",
  "validateSSL": false
}
{
  "aliasName": "",
  "clientId": 0,
  "clientUniqueId": "client_786966",
  "consoles": [],
  "createdDate": "2021-04-14T12:45:23+0000",
  "deleted": false,
  "encrypted": false,
  "frequency": 0,
  "hostName": "",
  "id": "5e24119a-8fd6-4295-9349-9e25a18fc072",
  "identity": "/subscriptions/fa50c578-bd7f-4cfb-ae12-f205420131b9/resourcegroups/QA/providers/Microsoft.IoTCentral/IoTApps/qa-iot",
  "installedApp": {
    "displayName": "AzureARM",
    "id": "INTG-74eeea20-3951-4397-a672-57bd4140ddca",
    "installedBy": "opsramp_api_user",
    "installedTime": "2021-04-14T13:35:47+0100",
    "integration": {
      "id": "AZURE",
      "multipleInstallations": true,
      "name": "Azure"
    },
    "status": "enabled"
  },
  "ipAddress": "",
  "locationOffset": 0,
  "name": "qa-iot",
  "paused": false,
  "port": 0,
  "properties": {
    "applicationId": null,
    "createdDate": null,
    "displayName": null,
    "geography": null,
    "provider": "AZURE",
    "state": null,
    "subdomain": null,
    "template": null,
    "uniqueId": "a05c51b2-dacb-4183-8c7b-f8e539c5754f"
  },
  "receiverHostPort": 0,
  "resourceName": "qa-iot",
  "resourceType": "AZ_IOT_CENTRAL",
  "source": "PUBLICCLOUD",
  "state": "active",
  "status": "UNKNOWN",
  "timeout": 0,
  "topologyEnabled": false,
  "totalLocations": 0,
  "ts": 0,
  "type": "AZ_IOT_CENTRAL",
  "updatedDate": "2021-04-15T02:25:52+0000",
  "validateSSL": false
}
{
  "clientUniqueId": "client_16",
  "consoles": [],
  "createdDate": "2018-05-03T06:29:38+0000",
  "id": "4f7f63a0-c7a3-4f2a-89de-74ff5eecb805",
  "location": {
    "id": 0,
    "name": "East US"
  },
  "resourceName": "SJ-Host",
  "source": "MANUAL",
  "state": "active",
  "status": "UP",
  "type": "EBS",
  "updatedDate": "2018-05-04T10:20:30+0000"
}
{
  "agentInstalled": false,
  "appRoles": [
    {
      "name": "cassandra"
    },
    {
      "name": "hbase"
    },
    {
      "name": "hdfs-namenode"
    }
  ],
  "bios": {
    "systemModel": "c1.medium",
    "systemSerial": ""
  },
  "clientUniqueId": "client_10",
  "components": [
    "disks"
  ],
  "consoles": [],
  "cpus": [],
  "extResourceId": "67034",
  "generalInfo": {
    "agentDeploytime": "2016-06-30T15:24:40+0000",
    "aliasName": "",
    "assetManagedTime": "",
    "createdTime": "2016-06-30T15:24:40+0000",
    "description": "",
    "dns": "",
    "encodingType": "UTF8",
    "firstAssetManagedTime": "",
    "hostName": "Test Device1",
    "keyboardType": "US104",
    "make": "",
    "name": "Test Device1",
    "osArchitecture": "64",
    "osName": "",
    "physicalMemory": "0.0",
    "resourceName": "",
    "resourceType": "Linux",
    "updatedTime": "2016-06-30T15:25:00+0000"
  },
  "id": "46646d0b-976f-46ed-b47b-40178f5b0508",
  "installedApp": {
    "displayName": "AWS_INTG",
    "id": "INTG-0d249a09-32a5-4703-b5c9-1475456f2011",
    "integration": {
      "id": "AWS",
      "name": "AWS"
    }
  },
  "ipAddress": "172.31.20.84",
  "location": {
    "city": "N.Virginia",
    "clientId": 10,
    "id": 516,
    "mspId": 3,
    "name": "us-east-1a"
  },
  "metricTypes": [
    {
      "availabilityMetric": false,
      "displayName": "Availability",
      "metricName": "resource.availability",
      "thresholdType": "STATIC",
      "unit": "COUNTER"
    }
  ],
  "networkCardDetails": [
    {
      "aliasIps": "172.24.133.100, 172.24.133.101",
      "dhcpEnabled": false,
      "id": 1,
      "ipAddress": "172.24.133.91",
      "linkMode": "MGNT_MODE_LINK",
      "macAddress": "f8:94:c2:0c:10:f2",
      "networkName": "wlp2s0",
      "status": "Up"
    }
  ],
  "properties": {
    "ami": "ami-021800badbd6a2e64",
    "instanceId": "i-0eff82b84a8037c2d",
    "instanceState": "running",
    "instanceType": "c1.medium",
    "launchDate": "2018-12-12T05:37:09+0000",
    "monitoringState": "disabled",
    "owner": "371067416711",
    "privateDns": "ip-172-31-20-84.ec2.internal",
    "privateIp": "172.31.20.84",
    "provider": "AWS",
    "publicIp": "34.202.160.29",
    "zone": "us-east-1a"
  },
  "source": "MANUAL",
  "state": "active",
  "status": "UP",
  "tags": [
    {
      "name": "test",
      "tagSource": "OPSRAMP",
      "value": "testValue"
    }
  ],
  "wsusSettings": "disabled"
}
{
  "checkType": "DNS",
  "clientId": 13598,
  "cloudInstance": false,
  "consoles": [],
  "deleted": false,
  "device": false,
  "encrypted": false,
  "excludeIndexing": false,
  "frequency": 0,
  "host": "www.dns-monitoring.com",
  "id": "1c83b80b-276c-4824-9501-90c89f058f2f",
  "locationOffset": 0,
  "locationUuids": [
    "5f618dd2-a019-4ce4-806d-9165c5a2c0dc"
  ],
  "name": "dnsResource",
  "paused": false,
  "port": 0,
  "receiverHostPort": 0,
  "resourceType": "SYNTHETIC",
  "saId": 0,
  "state": "active",
  "timeout": 0,
  "topologyEnabled": false,
  "totalLocations": 0,
  "ts": 1628589841000,
  "validateSSL": false
}
Endpoint
/api/v2/tenants/{tenantId}/resources/{resourceId}

Updates the details of a resource.

Path Parameters
tenantId
string

Describes the client ID of the tenant

resourceId
string

SslCertKeyPath
string

(Optional) Path of the SSL certificate key.

aliasName
string

Another name of a resource.

alternateIP
string

Gateway uses alternate IP to discover a resource when populated.

checkType
string

Category type for Synthetics. Example: http, https, ftp, and so on.

credential
object

(Optional) Credentials for Synthetics.

credential.oauthAccessTokenUrl
auth or oauth token.
credential.oauthClientKey
Generated client key.
credential.oauthClientSecret
Generated secret key.
credential.oauthGrantType
Credentials of the client.
credential.securityLevel
Security level. For example, oauth2.
description
string

Description for the resource.

downloadFilePath
string

(Optional) Path where you want to download the file.

extResourceId
string

Attach third-party integration ID.

logicalDiskDrives
array

logicalDiskDrives.freeDiskCriticalThreshold
Define a critical threshold value for free disk space. A critical alert is triggered when the free disk space exceeds the threshold value. Example: 80. The free disk threshold value is represented in MB.
logicalDiskDrives.freeDiskWarningThreshold
Define a warning threshold value for free disk space. A warning alert is triggered when the free disk space exceeds the threshold value. Example: 40
logicalDiskDrives.name
Name of the disk drive.
logicalDiskDrives.utilizationCriticalThreshold
Define a critical threshold value for disk utilization. A critical alert is triggered when the utilization exceeds the threshold value. The utilization threshold value is represented as a percentage.
logicalDiskDrives.utilizationWarningThreshold
Define a warning threshold value for disk utilization. A warning alert is triggered when the utilization exceeds the threshold value. Example: 60
managementProfile
string

Name of management profile of a resource that is managed.

oobInterfaceCards
array

OOB interface card details.

oobInterfaceCards.accessInfo
oobInterfaceCards.accessInfoIpV4
oobInterfaceCards.description
oobInterfaceCards.macAddress
oobInterfaceCards.make
oobInterfaceCards.model
oobInterfaceCards.name
oobInterfaceCards.oobVersion
oobInterfaceCards.port
oobInterfaceCards.remoteAccessType
oobInterfaceCards.url
providerType
string

Type of provider.

providerUID
string

Unique ID of provider.

resourceNetworkInterface
array

Details of network interface.

resourceNetworkInterface.default
resourceNetworkInterface.ipAddress
resourceNetworkInterface.ipAddressType
resourceNetworkInterface.macAddress
resourceType
string

Type of resource. Example: server, SYNTHETICS

script
string

serialNumber
string

Serial number of resource.

sslCertPath
string

(Optional) Path of the SSL Certificate

systemUID
string

Unique ID of system.

{
  "aliasName": "aliasServerName",
  "alternateIP": "4.2.2.2",
  "extResourceId": "67035",
  "logicalDiskDrives": [
    {
      "freeDiskCriticalThreshold": 0,
      "freeDiskWarningThreshold": 0,
      "name": "/",
      "utilizationCriticalThreshold": 90,
      "utilizationWarningThreshold": 85
    },
    {
      "freeDiskCriticalThreshold": 0,
      "freeDiskWarningThreshold": 0,
      "name": "/boot/efi",
      "utilizationCriticalThreshold": 90,
      "utilizationWarningThreshold": 85
    }
  ],
  "managementProfile": "Gateway Profile",
  "oobInterfaceCards": [
    {
      "accessInfo": "source-ip location",
      "accessInfoIpV4": "121.32.21.112",
      "description": "Server controller details",
      "macAddress": "hj:12:hb:32:vg:sa",
      "make": "Cisco Routers",
      "model": "Cisco 890 Series",
      "name": "Controller 1",
      "oobVersion": "7.5",
      "port": 443,
      "remoteAccessType": "SSH",
      "url": "https://www.myorganization.com/"
    }
  ],
  "resourceNetworkInterface": [
    {
      "default": 1,
      "ipAddress": "121.156.43.12",
      "ipAddressType": "STATIC",
      "macAddress": "5G:7H:HN:12:8H:D7"
    },
    {
      "default": 0,
      "ipAddress": "161.32.556.56",
      "ipAddressType": "STATIC",
      "macAddress": "00:0C:23:C5:D6:H7"
    },
    {
      "default": 0,
      "ipAddress": "161.11.132.21",
      "ipAddressType": "DHCP",
      "macAddress": "00:0C:32:B7:D8:54"
    }
  ],
  "resourceType": "server"
}
{
  "checkType": "DNS",
  "locationUuids": [
    "5f618dd2-a019-4ce4-806d-9165c5a2c0dc"
  ],
  "resourceName": "dnsResource",
  "resourceType": "SYNTHETIC",
  "url": "www.dns-monitoring.com"
}

Responses

OK