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.

Cloud Agents REST API

Owned by Sara Weisz
Last updated: Dec 20, 2023
8 min read

Available Cloud Agents actions via APIs

Get / Create / Update/ Update Setup/ Get info/ Delete Cloud Agents

Authorization:

Authentication: Basic authentication

Roles: it is recommended to read page for understanding build-in and custom roles permissions.

From CLI (example):

curl -u username:password https://<dpod hostname>/op/api/v2/cloudAgents

GET Retrieve All Cloud Agents

URL:

GET - https://{{dpodHostname}}/op/api/v2/cloudAgents/

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. Access permissions for any product view

  2. Access permissions for Manage Cloud Agents

See roles information here:

Response:

Response Type

Example value

Description

Response Type

Example value

Description

Successful

{ "resultCode": "SUCCESS", "resultMessage": "Cloud agents retrieved successfully.", "result": { "cloudAgents": [ { "id": 1, "name": "dpod-cloud-agent-dev@dpod-cloud-agent-ns", "managerUrl": "https://dpod-cloud-agent-manager.apps.ocp4.montier.com/op", "somaPort": 5550, "syslogIngesterServiceName": "dpod-cloud-agent-dev-syi-svc.dpod-cloud-agent-ns", "syslogIngesterServicePort": 60000, "httpIngesterServiceName": "dpod-cloud-agent-dev-hti-svc.dpod-cloud-agent-ns", "httpIngesterServicePort": 60020, "messagingInternalBootstrapServers": "dpod-cloud-agent-dev-msg-bsi-svc:9092", "messagingExternalBootstrapServers": "dpod-cloud-agent-messaging.apps.ocp4.montier.com:30100", "isAutoSetupSyslog": true, "isAutoSetupWsm": true, "autoSetupAnalysisLevel": "DEFAULT", "autoSetupDomainsPatterns": "*", "isAutoSetupCertificateMonitor": true, "isAutoSetupApiProbe": false, "disabledSamplings": "" } ] } }

Status code: 200

resultCode → SUCCESS

resultMessage → “Cloud agents retrieved successfully"

 

GET Get Specific Cloud Agent Details

URL:

GET - https://{{dpodHostname}}/op/api/v2/cloudAgent/{{cloudAgentId}}

URL Parameters:

Name

Is required

Description

Parameter Type

Name

Is required

Description

Parameter Type

cloudAgentId

True

The cloud agent id (can be retrieved from “Retrieve All Cloud Agents” response)

Number

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. Access permissions for any product view

  2. Access permissions for Manage Cloud Agents

See roles information here:

Response:

Response Type

Example value

Description

Response Type

Example value

Description

Successful

{ "resultCode": "SUCCESS", "resultMessage": "Cloud agent retrieved successfully.", "result": { "id": 1, "name": "dpod-cloud-agent-dev@dpod-cloud-agent-ns", "managerUrl": "https://dpod-cloud-agent-manager.apps.ocp4.montier.com/op", "somaPort": 5550, "syslogIngesterServiceName": "dpod-cloud-agent-dev-syi-svc.dpod-cloud-agent-ns", "syslogIngesterServicePort": 60000, "httpIngesterServiceName": "dpod-cloud-agent-dev-hti-svc.dpod-cloud-agent-ns", "httpIngesterServicePort": 60020, "messagingInternalBootstrapServers": "dpod-cloud-agent-dev-msg-bsi-svc:9092", "messagingExternalBootstrapServers": "dpod-cloud-agent-messaging.apps.ocp4.montier.com:30100", "isAutoSetupSyslog": true, "isAutoSetupWsm": true, "autoSetupAnalysisLevel": "DEFAULT", "autoSetupDomainsPatterns": "*", "isAutoSetupCertificateMonitor": true, "isAutoSetupApiProbe": false, "disabledSamplings": "" } }

Status code: 200

resultCode → SUCCESS

resultMessage → “Cloud agent retrieved successfully”

Failure

Status code: 500

resultCode → ERROR

resultErrorCode → NTERNAL_ERROR

resultMessage → “Error processing request”

POST Add Cloud Agent

URL:

POST - https://{{dpodHostname}}/op/api/v2/cloudAgents/

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. Access permissions for any product view

  2. Access permissions for Manage Cloud Agents

See roles information here:

Request body:

Type

Parameters

Example Json

Description

Type

Parameters

Example Json

Description

Required

  1. String managerUrl

  2. String credentials

 

Additional parameter

Available disabledSamplings

*Use this with caution, only when requested by the support team.

  • Sampling types:

    • 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

Response:

Response Type

Example value

Description

Response Type

Example value

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “Cloud agent added successfully”

Failure

Status code: 200

resultCode → ERROR

resultErrorCode → INTERACT_FAILED

resultMessage → “Failed to communicate with the cloud agent manager, make sure it is running and the inbound (ingress) communication is configured properly.”

put Update Cloud Agent

URL:

PUT - https://{{dpodHostname}}/op/api/v2/cloudAgent/{{cloudAgentId}}

URL Parameters:

Name

Is required

Description

Parameter Type

Name

Is required

Description

Parameter Type

cloudAgentId

True

The cloud agent id (can be retrieved from “Retrieve All Cloud Agents” response)

Number

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. Access permissions for any product view

  2. Access permissions for Manage Cloud Agents

See roles information here:

Request:

Type

Parameters

Example Json

Description

Type

Parameters

Example Json

Description

Required

  1. String managerUrl

 

Additional parameter

String credentials

 

Additional parameter

Available disabledSamplings

*Use this with caution, only when requested by the support team.

  • Sampling types:

    • 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

Response:

Response Type

Example value

Description

Response Type

Example value

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “Cloud agent updated successfully”

POST Update Cloud Agent Setup

URL:

POST - https://{{dpodHostname}}/op/api/v2/cloudAgent/{{cloudAgentId}}/updateSetup

URL Parameters:

Name

Is required

Description

Parameter Type

Name

Is required

Description

Parameter Type

cloudAgentId

True

The cloud agent id (can be retrieved from “Retrieve All Cloud Agents” response)

Number

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. Access permissions for any product view

  2. Access permissions for Manage Cloud Agents

See roles information here:

Request body:

Type

Parameters

Example Json

Description

Type

Parameters

Example Json

Description

Required

  1. Boolean isAutoSetupSyslog

  2. Boolean isAutoSetupWsm

  3. String autoSetupAnalysisLevel

  4. String autoSetupDomainsPatterns

  5. Boolean isAutoSetupCertificateMonitor

  6. Boolean isAutoSetupApiProbe

  7. String apiProbeGatewayPeering (only required if isAutoSetupApiProbe = true)

  • Types of autoSetupAnalysisLevel:

    • DEFAULT

    • MAX_DATA

    • MORE_DATA

    • BALANCED

    • MORE_TPS

    • MAX_TPS

Response:

Response Type

Example value

Description

Response Type

Example value

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “Cloud agent setup saved successfully”

POST Cloud Agent Info

DELETE Delete Cloud Agent

 

Copyright © 2015 MonTier Software (2015) Ltd.