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

Header format

HeaderValue
AuthorizationBearer {accessToken}
Content-typeapplication/json
Acceptapplication/json

Status code

200 OK

Parameters

All field are mandatory unless specified otherwise.

Integer
FieldData TypeDescription
aliasNameString(Optional) Another name of a resource.
alternateIPString(Optional) Alternate IP for the gateway to discover when a resource is populated.
extResourceIdString(Optional) External ID for a third-party integration resource.
managementProfileString(Optional) Name of management profile of a resource that is managed.
descriptionString(Optional) Description for the resource.
resourceNetworkInterfaceString(Optional) Details of network interface.
  • ipAddressType.
  • macAddress
  • default
  • ipAddress
resourceTypeString(Required for Synthetics, otherwise, Optional) Type of resource.
Example: server, SYNTHETIC
systemUIDString(Optional) Unique ID of system.
serialNumberString(Optional) Serial number of resource.
providerTypeString(Optional) Type of provider.
providerUIDString(Optional) Unique ID of provider.
logicalDiskDrives: nameString(Required) Name of the disk drive.
logicalDiskDrives: utilizationWarningThresholdInteger(Optional) Warning threshold value for disk utilization. A warning alert is triggered when the utilization exceeds the threshold value.
Values: Between 0 and 100, Example: 60
logicalDiskDrives: utilizationCriticalThresholdInteger(Optional) 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.
Values: Between 0 and 100
logicalDiskDrives: freeDiskWarningThresholdInteger(Optional) warning threshold value for free disk space. A warning alert is triggered when the free disk space exceeds the threshold value.
Values: Between 0 and 100, Example: 40
logicalDiskDrives: freeDiskCriticalThreshold(Optional) Critical threshold value for free disk space. A critical alert is triggered when the free disk space exceeds the threshold value.
Values: Between 0 and 100, Example: 80
The free disk threshold value is represented in MB.
oobInterfaceCardsString(Optional) OOB interface card details.
  • name (Required)
  • macAddress (Required)
  • description
  • url
  • oobVersion
  • accessInfo
  • accessInfoIpV4
  • remoteAccessType
  • port
  • make
  • model
checkTypeString(Required for Synthetics) Specifies the category type.
Examples: http, https, and ftp.
credential
  • securityLevel
  • oauthClientKey
  • oauthClientSecret
  • oauthAccessTokenUrl
  • oauthGrantType
String(Required for Synthetics if provided in create API) Specifies the credentials.
Examples:
  • securityLevel: oauth2
  • oauthClientKey: client key generated
  • oauthClientSecret: secret key generated
  • oauthAccessTokenUrl: auth/oauth token
  • oauthGrantType: credentials of the client
sslCertPathString(Optional) Path of the SSL Certificate
SslCertKeyPathString(Optional) Path of the SSL certificate key.
downloadFilePathString(Optional) Specifies the path where you want to download the file.
scriptString(Optional) Use this text only if the checkType is set to SCRIPT.

Sample 1 - Generic

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

Sample 2 - Synthetic

Sample request

{
	"resourceType":"SYNTHETIC",
	"checkType" : "HTTP",
	"resourceName" : "Indians",
	"url" : "www.oriental.com",
	"credential" :{
			"securityLevel" : "oauth2",
			"oauthClientKey" : "kHSageRP9CTeCFP7Wfrzzc45pFJZ99N4",
			"oauthClientSecret" : "5w6rKEAgYpsYDdd8vm5PnUMsQWqTnh423FArQYxGW6V3zqDcTG2z7UvjV3YBMq9Y",
			"oauthAccessTokenUrl" : "auth/oauth/token",
			"oauthGrantType" : "client_credentials"
			},
	"locationUuids" :
	   [ "7b77f37f-5eb0-4ec2-bd19-15cc6853e3ca"]  
}

Sample response

Null