Reference Guide

SupportAssist Enterprise
31 REST API Guide – SupportAssist Enterprise
The following is an example of a JSON for adding a device.
Request body:
{
"deviceAddress": "<ip address/host name>",
"friendlyName": "device friendly name",
"uiDeviceType": "<ui device Type>",
"deviceSubType": "<Sub type>",
"deviceFamily": "<device family>",
"credentialAccountId": "<Credential Account Id>",
"credentialProfileId": "<Credential profile id>",
"enableMonitoring": <true|false>,
"configureSNMP": <true|false>,
"installOMSA": <true|false>,
"enableDeepDiscovery": <true|false>
}
Response format (Accepted – response code 202):
{
"operationId": "<operation_id>",
"operationType": "DiscoverDevice",
"status": "QUEUED",
"additionalInfo": null
}
Job success status response
{
"operationId": "<operation_id>",
"operationType": "DiscoverDevice",
"status": "SUCCESS",
"additionalInfo": [
{
"errorCode": "SA-90100",
"message": "Operation successful.",
"additionalInfo": "<device_id>"
}
]
}
Note: The response contains the device id of the added device.
2.6.2 Edit device details
The following resource URI is used to edit the details of a device:
https://<BASE_URI>/SupportAssist/api/v1/Device
Method: PUT
Headers:
Content-Type: application/json
Authorization: Bearer <Authentication_Token>