IBM DataPower Operations Dashboard v1.0.14.0
A newer version of this product documentation is available.
You are viewing an older version. View latest at IBM DPOD Documentation.
Gateway/s REST API
- Sara Weisz
Owned by Sara Weisz
User will need an admin access for this API, Unauthorized users will get "401 Unauthorized"
Get Gateway By Name:
curl -X POST \
 https://<IP>:443/op/api/v1/gateways/getByName \
 -H 'Authorization: Basic YWRtaW46YWRtaW51c2Vy' \
 -H 'Cache-Control: no-cache' \
 -H 'Content-Type: application/json' \
 -H 'cache-control: no-cache' \
 -d '{
  "name": "datapower1-7dc474c48c-chtpg"
}'
Result example:Â
{
  "result": {
    "host": "172.17.100.100",
    "id": 103,
    "isDeviceResourcesMonitored": true,
    "isServiceResourcesMonitored": true,
    "logTargetSourceAddress": "192.168.226.229",
    "name": "datapower1-7dc474c48c-chtpg",
    "somaPort": 5550,
    "somaUserName": "admin"
  },
  "resultCode": "SUCCESS"
}
Update Gateway:
curl -X PUT \
 https://<IP>:443/op/api/v1/gateway/<ID> \
 -H 'Authorization: Basic YWRtaW46YWRtaW51c2Vy' \
 -H 'Content-Type: application/json' \
 -H 'cache-control: no-cache' \
 -d '{
  "name": "datapower1-7dc474c48c-chtpg",
  "host": "172.17.100.100",
  "somaPort": "5550",
  "somaUserName": "admin",
  "somaPassword": "admin",
  "logTargetSourceAddress": "192.168.226.229",
  "isDeviceResourcesMonitored": "true",
  "isServiceResourcesMonitored": "true",
  "reSetupSyslogForDevice": "true",
  "reSetupSyslogForAllDomains": "false",
  "reSetupWsmForDevice": "false",
  "reSetupWsmForAllDomains": "false"
}'
The following fields are mandatory: reSetupSyslogForDevice/reSetupSyslogForAllDomains/reSetupWsmForDevice/reSetupWsmForAllDomains
Result example:Â
{
  "result": {
    "id": 103
  },
 "resultCode": "SUCCESS"}