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.

Agents REST API

User will need an admin access for this API, Unauthorized users will get "401 Unauthorized"


Add Syslog agent:

POST /op/api/v1/agents/syslog?name=newAgent&host=someHost&port=1234&nodeName=N001&keepalive=true
{
  "resultCode": "OK"
}

error:
{
  "resultCode": "ERROR",
  "resultMessage": "Error - Name field is empty or null"
}


Add WS-M agent:
POST /op/api/v1/agents/wsm?name=newWsmAgent&host=someHost&port=1234&nodeName=N001&keepalive=true
{
  "resultCode": "OK"
}

error:
{
  "resultCode": "ERROR",
  "resultMessage": "Error - node not found"
}


Delete Syslog agent:
DELETE /op/api/v1/agent/syslog/someAgentName
{
  "resultCode": "OK"
}

error:
{
  "resultCode": "ERROR",
  "resultMessage": "Error - No Agents found with the name newAgent2"
}


Delete WS-M agent:
DELETE /op/api/v1/agent/wsm/someAgentName
{
  "resultCode": "OK"
}

error:
{
  "resultCode": "ERROR",
  "resultMessage": "Error - No Agents found with the name newWsmAgent1"
}

IBM DataPower Operations Dashboard (DPOD) v1.0.14.0