/
Devices REST API

IBM DataPower Operations Dashboard v1.0.20.x

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Devices REST API

Owned by Assaf Cohen (Deactivated)
Last updated: Dec 17, 2023 by Avi Falah
2 min read

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

URL:

POST - https://{{dpodHostname}}/op/api/v1/devices?param1=value1&param2=value2...

URL Parameters:

Name

Is required

Description

Parameter Type

Data options

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

  • HOST_ALIAS

  • IP_ADDRESS

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

  • AUDIT_LOG_GETTER

  • CONFIG_SERVICES

  • DEVICE_RESOURCES

  • DEVICE_SETUP

  • INTERNAL_ALERTS_CHECK_LOGTARGET_MISCONFIG

  • MQ_OBJECTS_STATS

  • SERVICE_RESOURCES

  • OBJECTS_STATUS_MONITOR

  • WSM_AGENTS_STATS

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:

Required Permissions

More info

Required Permissions

More info

  1. Administrator role

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

Response Type

Example value

Description

Successful

{"resultCode": "SUCCESS","resultMessage": ""}

Status code: 200

resultCode → SUCCESS

resultMessage → “”

 

 

POST Refresh Agents

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:

Required Permissions

More info

Required Permissions

More info

  1. Administrator role

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

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)









Copyright © 2015 MonTier Software (2015) Ltd.