Available report actions via APIs
Add Device / Refresh Agents
Authorization:
Authentication: Basic authentication
Roles: it is recommended to read Role Based Access Control page for understanding build-in and custom roles permissions.
From CLI (example):
curl -u username:password https://<dpod hostname>/op/api/v1/devices{{parameters}}
POST Add Device
/op/api/v1/devices/?param1=value1¶m2=value2...
URL:
POST - https://{{dpodHostname}}/op/api/v1/devices?param1=value1¶m2=value2...
URL Parameters:
Name | Is required | Description | Parameter Type | Data options |
|---|
name | True | The gateway name in DPOD (must be identical to the System Identifier of the gateway) | String | |
host | True | IP Address used to access the gateway. | String | |
romaPort | True | The ROMA port configured on this gateway. | String | |
somaPort | True | The SOMA port configured on this gateway. | String | |
somaUser | True | The user name used to access the monitored devices via SOMA/ROMA. | String | |
somaPassword | True | The password of the user name used to access the monitored devices via SOMA/ROMA. | String | |
logTargetAddressType | True | Log Target source address type. | String | |
logTargetAddress | True | IP Address or host alias. | String | |
disabledSamplings | True | Disabled Samplings
* Use this with caution, only when requested by the support team. | String | |
syslogAgentName | True | Syslog agent name. | String | |
setupSyslogForDomains | True | Auto setup Syslog agents for new domains | String | true/false |
domainsAnalysisLevel | True | Log Target Analysis Level, see: Log Target Analysis Levels. | String | |
wsmAgentName | True | WS-M agent name. | String | |
setupWsmForDomains | True | Auto setup WS-M agents for new domains | String | |
setupCertificateMonitor | True | Use Certificate monitor | String | true/false |
autoSetupPattern | True | Domain pattern (use asterisk as wildcard) | String | |
autoSetupSyslogAgentName | True | Syslog agent name for new domains. | String | |
autoSetupWsmAgentName | True | WS-M agent name for new domains. | String | |
autoSetupAnalysisLevel | True | Log Target Analysis Level, see: Log Target Analysis Levels. | String | |
monitorTxInDefaultDomain | True | Monitor transactions in default domain. | String | true/false |
Authorization:
Response:
Response Type | Example value | Description |
|---|
Successful |
{"resultCode": "SUCCESS","resultMessage": ""}
| Status code: 200 resultCode → SUCCESS resultMessage → “” |
POST Refresh Agents
/op/api/v1/devices/refreshAgents
This service method will disable all log targets, setup host aliases again and re-enable all log targets.
If the device cannot be reached - it will be skipped.
Errors or exceptions will not stop the operation.
URL:
POST - https://{{dpodHostname}}/op/api/v1/devices/refreshAgents
Authorization:
Response:
Response Type | Example value | Description |
|---|
Successful |
{"resultCode": "SUCCESS","resultMessage": "Device added successfully"}
| Status code: 200 resultCode → SUCCESS resultMessage → “Device added successfully” |
*Setup all devices host aliases (for DR)