Documentation is now available for the Fall 2020 Update release!

Update resource

This endpoint is used to update details of a resource.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/resources/{resourceId}

Sample URLs

https://{api-url}/api/v2/tenants/client_12/resources/612acfb0-6890-4d52-950b-1c4ec17a7248

Parameters

All fields are optional except name and macAddress (oobInterfaceCards):

logicalDiskDrives
FieldData TypeDescription
aliasNameStringAnother name of a resource.
alternateIPStringAlternate IP for the gateway to discover when a resource is populated.
extResourceIdStringExternal ID for a third-party integration resource.
managementProfileStringName of management profile of a resource that is managed.
descriptionStringDescription for the resource.
resourceNetworkInterfaceStringDetails of network interface.
  • ipAddressType.
  • macAddress
  • default
  • ipAddress
resourceTypeStringType of resource.
Example: server
systemUIDStringUnique ID of system.
serialNumberStringSerial number of resource.
providerTypeStringType of provider.
providerUIDStringUnique ID of provider.
  1. String
  2. Integer
  3. Integer
  4. Integer
  5. Integer
  1. Name of the disk drive.
  2. Warning threshold value for disk utilization. A warning alert is triggered when the utilization exceeds the threshold value.
    Example: 60
  3. 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.
  4. warning threshold value for free disk space. A warning alert is triggered when the free disk space exceeds the threshold value.
    Example: 40
  5. 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.

Utilization and free disk space threshold values should be between 0 and 100.

oobInterfaceCardsStringOOB interface card details.
  • name (required)
  • macAddress (required)
  • description
  • url
  • oobVersion
  • accessInfo
  • accessInfoIpV4
  • remoteAccessType
  • port
  • make
  • model

Sample request

{
	"aliasName" : "aliasServerName",
	"alternateIP": "4.2.2.2",
	"extResourceId" : "67035",
	"managementProfile": "VG 1",
	"description": "test description",
	"resourceNetworkInterface": [{
			"ipAddressType": "STATIC",
			"macAddress": "2E:8B:EB:32:7A:F9",
			"default": 1,
			"ipAddress": "192.168.56.86"
		},
		{
			"ipAddressType": "STATIC",
			"macAddress": "00:0C:29:B8:C8:8F",
			"default": 0,
			"ipAddress": "172.22.221.90"
		},
		{
			"ipAddressType": "DHCP",
			"macAddress": "00:0C:29:B8:C8:95",
			"default": 0,
			"ipAddress": "172.22.100.86"
		}
	],
	"logicalDiskDrives": [{
			"name": "/",
			"utilizationWarningThreshold": 85,
			"utilizationCriticalThreshold": 90,
			"freeDiskWarningThreshold": 0,
			"freeDiskCriticalThreshold": 0
		},
		{
			"name": "/boot/efi",
			"utilizationWarningThreshold": 85,
			"utilizationCriticalThreshold": 90,
			"freeDiskWarningThreshold": 0,
			"freeDiskCriticalThreshold": 0
		}
	],
	"oobInterfaceCards": [{
		"name": "Controller 1",
		"macAddress": "hj:23:gb:67:vb:sd",
		"description": "Demo Description",
		"url": "https://www.acmeit.com/",
		"oobVersion": "7.5",
		"accessInfo": "source-ip location",
		"accessInfoIpV4": "122.28.20.123",
		"remoteAccessType": "SSH",
		"port": 443,
		"make": "Cisco Routers",
		"model": "Cisco 890 Series"
	}]
}

Sample response

Null