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
Header | Value |
---|---|
Authorization | Bearer {accessToken} |
Content-type | application/json |
Accept | application/json |
Status code
200 OK
Parameters
All field are mandatory unless specified otherwise.
Field | Data Type | Description |
---|---|---|
aliasName | String | (Optional) Another name of a resource. |
alternateIP | String | (Optional) Alternate IP for the gateway to discover when a resource is populated. |
extResourceId | String | (Optional) External ID for a third-party integration resource. |
managementProfile | String | (Optional) Name of management profile of a resource that is managed. |
description | String | (Optional) Description for the resource. |
resourceNetworkInterface | String | (Optional) Details of network interface.
|
resourceType | String | (Required for Synthetics, otherwise, Optional) Type of resource. Example: server, SYNTHETIC |
systemUID | String | (Optional) Unique ID of system. |
serialNumber | String | (Optional) Serial number of resource. |
providerType | String | (Optional) Type of provider. |
providerUID | String | (Optional) Unique ID of provider. |
logicalDiskDrives: name | String | (Required) Name of the disk drive. |
logicalDiskDrives: utilizationWarningThreshold | Integer | (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: utilizationCriticalThreshold | Integer | (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: freeDiskWarningThreshold | Integer | (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 | Integer(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. | |
oobInterfaceCards | String | (Optional) OOB interface card details.
|
checkType | String | (Required for Synthetics) Specifies the category type. Examples: http, https, and ftp. |
credential
| String | (Required for Synthetics if provided in create API) Specifies the credentials. Examples:
|
sslCertPath | String | (Optional) Path of the SSL Certificate |
SslCertKeyPath | String | (Optional) Path of the SSL certificate key. |
downloadFilePath | String | (Optional) Specifies the path where you want to download the file. |
script | String | (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
Note
The response depends on the returned status code.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