IBM DataPower Operations Dashboard v1.0.22.x
Gateway/s REST API
Sara Weisz
In this page:
post Get a Gateway
Description:
This API retrieves a specific gateway.
Required Roles:
One of the following:
The OpDashAdminRole builtin role.
The OpDashOperatorRole builtin role.
URI:
/op/api/v1/gateways/getByName
Request:
The request should use the POST method with the following fields in its body:
Name | Required / Optional | Description | Type | Available Options |
|---|
Name | Required / Optional | Description | Type | Available Options |
|---|---|---|---|---|
name | Required | The gateway name in DPOD (must be identical to the System Identifier of the gateway) | String |
|
Example:
{
"name": "idg_10_5_0_a"
}Successful Response:
The response includes the following fields in its resultelement:
Name | Description | Type | Available Options |
|---|
Name | Description | Type | Available Options |
|---|---|---|---|
id | The ID of the gateway. | Long |
|
name | The gateway name in DPOD (must be identical to the System Identifier of the gateway) | String |
|
host | IP Address used to access the gateway. | String |
|
somaPort | The SOMA port configured on this gateway. | String |
|
somaUserName | The user name used to access the monitored devices via SOMA/ROMA. | String |
|
logTargetSourceAddress | IP Address or host alias. | String |
|
disabledSamplings | Disabled Samplings
| String |
|
Example:
{
"resultCode": "SUCCESS",
"result": {
"id": 14,
"name": "idg_10_5_0_a",
"host": "1.1.1.1",
"somaPort": 5550,
"somaUserName": "admin",
"logTargetSourceAddress": "1.1.1.1",
"disabledSamplings": ""
}
}
put Edit a Gateway
Description:
This API edits a specific gateway and re-setup all.
Required Roles:
One of the following:
The OpDashAdminRole builtin role.
The OpDashOperatorRole builtin role.
URI:
/op/api/v1/gateway/{{gatewayId}}
Request:
The request should use the PUT method with the following URL parameters:
Name | Required/Optional | Description | Type | Available Options |
|---|
Name | Required/Optional | Description | Type | Available Options |
|---|---|---|---|---|
| Required | The gateway ID. | Long |
|
The request should use the PUT method with the following fields in its body:
Name | Required/Optional | Description | Type | Available Options |
|---|
Name | Required/Optional | Description | Type | Available Options |
|---|---|---|---|---|
name | Optional | The gateway name in DPOD (must be identical to the System Identifier of the gateway) | String |
|
host | Optional | IP Address used to access the gateway. | String |
|
somaPort | Optional | The SOMA port configured on this gateway. | String |
|
somaUserName | Optional | The user name used to access the monitored devices via SOMA/ROMA. | String |
|
somaPassword | Optional | The password of the user name used to access the monitored devices via SOMA/ROMA. | String |
|
logTargetSourceAddress | Optional | IP Address or host alias. | String |
|
disabledSamplings | Optional | Disabled Samplings
| String |
|
reSetupSyslogForDevice | Required | Re-setup Syslog agents for device. | Boolean |
|
reSetupSyslogForAllDomains | Required | Re-setup Syslog agents for all domains. | Boolean |
|
reSetupWsmForDevice | Required | Re-setup WS-M agents for device. | Boolean |
|
reSetupWsmForAllDomains | Required | Re-setup WS-M agents for all domains. | Boolean |
|
Example:
{
"name": "idg_10_5_0_a",
"host": "1.1.1.1",
"somaPort": 5550,
"somaUserName": "admin",
"logTargetSourceAddress": "1.1.1.1",
"disabledSamplings": "AUDIT_LOG_GETTER",
"reSetupSyslogForDevice": true,
"reSetupSyslogForAllDomains": true,
"reSetupWsmForDevice": true,
"reSetupWsmForAllDomains": true
}Successful Response:
The response includes the following fields in its resultelement:
Name | Description | Type | Available Options |
|---|
Name | Description | Type | Available Options |
|---|---|---|---|
id | The gateway ID. | Long |
|
Example:
Copyright © 2015 MonTier Software (2015) Ltd.