Cloud Agents REST API

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 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/v2/cloudAgents

GET Retrieve All Cloud Agents

URL:

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

Authorization:

Required Permissions	More info

Required Permissions	More info
Access permissions for any product view Access permissions for Manage Cloud Agents	See roles information here: Role Based Access Control

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
Access permissions for any product view Access permissions for Manage Cloud Agents	See roles information here: Role Based Access Control

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

{
    "resultCode": "ERROR",
    "resultErrorCode": "INTERNAL_ERROR",
    "resultMessage": "Error processing request.",
    "uuid": "b3d42ddd-aba6-4f46-b4b0-07ddeba1719c"
}

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
Access permissions for any product view Access permissions for Manage Cloud Agents	See roles information here: Role Based Access Control

Request body:

Type	Parameters	Example Json	Description

Type

Parameters

Example Json

Description

Required

String managerUrl
String credentials

{
    "managerUrl": "https://dpod-cloud-agent-manager.apps.ocp4.montier.com/op",
    "credentials": "GZqEJ0zqZDUVcio641uonYC1DjqDRtDoQyhLjdt1mE8="
}

Additional parameter

Available disabledSamplings

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

{
   ....
     "disabledSamplings": "DEVICE_RESOURCES,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"
    ....
}

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

{
    "resultCode": "SUCCESS",
    "resultMessage": "Cloud agent added successfully.",
    "result": {
        "id": 3,
        "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": false,
        "isAutoSetupWsm": false,
        "isAutoSetupCertificateMonitor": false,
        "isAutoSetupApiProbe": false,
        "disabledSamplings": "DEVICE_RESOURCES"
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “Cloud agent added successfully”

Failure

{
    "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.",
    "uuid": "06253dcc-f101-4677-9d98-6e3e9a28356f"
}

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
Access permissions for any product view Access permissions for Manage Cloud Agents	See roles information here: Role Based Access Control

Request:

Type	Parameters	Example Json	Description

Type

Parameters

Example Json

Description

Required

String managerUrl

{
    "managerUrl": "https://dpod-cloud-agent-manager.apps.ocp4.montier.com/op"
}

Additional parameter

String credentials

{
   ....
     "credentials": "GZqEJ0zqZDUVcio641uonYC1DjqDRtDoQyhLjdt1mE8="
    ....
}

Additional parameter

Available disabledSamplings

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

{
   ....
     "disabledSamplings": "DEVICE_RESOURCES,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"
    ....
}

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

{
    "resultCode": "SUCCESS",
    "resultMessage": "Cloud agent updated successfully.",
    "result": {
        "id": 4,
        "name": "dpod-cloud-agent-dev@dpod-cloud-agent-ns",
        "managerUrl": "https://dpod-cloud-agent-manager.apps.ocp4.montier.com/op",
        "credentials": "",
        "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": false,
        "isAutoSetupWsm": false,
        "isAutoSetupCertificateMonitor": false,
        "isAutoSetupApiProbe": false,
        "disabledSamplings": "AUDIT_LOG_GETTER,CONFIG_SERVICES"
    }
}v

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
Access permissions for any product view Access permissions for Manage Cloud Agents	See roles information here: Role Based Access Control

Request body:

Type	Parameters	Example Json	Description

Type	Parameters	Example Json	Description
Required	Boolean isAutoSetupSyslog Boolean isAutoSetupWsm String autoSetupAnalysisLevel String autoSetupDomainsPatterns Boolean isAutoSetupCertificateMonitor Boolean isAutoSetupApiProbe String apiProbeGatewayPeering (only required if isAutoSetupApiProbe = true)	`{ "isAutoSetupSyslog": true, "isAutoSetupWsm": true, "autoSetupAnalysisLevel": "DEFAULT", "autoSetupDomainsPatterns": "*", "isAutoSetupCertificateMonitor": true, "isAutoSetupApiProbe": true, "apiProbeGatewayPeering": "API.Probe" }`	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

{
    "resultCode": "SUCCESS",
    "resultMessage": "Cloud agent setup saved successfully",
    "result": {
        "id": 4,
        "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": true,
        "apiProbeGatewayPeering": "API.Probe",
        "disabledSamplings": "AUDIT_LOG_GETTER,CONFIG_SERVICES"
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “Cloud agent setup saved successfully”

POST Cloud Agent Info

URL:

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

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
Access permissions for any product view Access permissions for Manage Cloud Agents	See roles information here: Role Based Access Control

Request - None.

Response:

Response Type	Example value	Description

Response Type

Example value

Description

Successful

{
    "resultCode": "SUCCESS",
    "resultMessage": "Cloud agent info retrieved successfully.",
    "result": {
        "cloudAgentVersion": "1.0.20.0 2023-11-22 04:23:12 Z",
        "cloudAgentEndpointsValidations": [
            {
                "endpoint": "https://dpod-cloud-agent-manager.apps.ocp4.montier.com/op",
                "resultMessage": "SUCCESS"
            },
            {
                "endpoint": "dpod-cloud-agent-messaging.apps.ocp4.montier.com:30100",
                "resultMessage": "SUCCESS"
            }
        ]
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “Cloud agent info retrieved successfully”

DELETE Delete Cloud Agent

URL:

DELETE - 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
Access permissions for any product view Access permissions for Manage Cloud Agents	See roles information here: Role Based Access Control

Response:

Response Type	Example value	Description

Response Type

Example value

Description

Successful

{
    "resultCode": "SUCCESS",
    "resultMessage": "Cloud agent deleted 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 deleted successfully”

IBM DataPower Operations Dashboard v1.0.21.x

Cloud Agents REST API

Available Cloud Agents actions via APIs

Authorization:

From CLI (example):

GET Retrieve All Cloud Agents

URL:

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

Authorization:

Response:

GET Get Specific Cloud Agent Details

URL:

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

URL Parameters:

cloudAgentId

Authorization:

Response:

POST Add Cloud Agent

URL:

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

Authorization:

Request body:

Response:

put Update Cloud Agent

URL:

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

URL Parameters:

cloudAgentId

Authorization:

Request:

Response:

POST Update Cloud Agent Setup

URL:

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

URL Parameters:

cloudAgentId

Authorization:

Request body:

Response:

POST Cloud Agent Info

URL:

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

URL Parameters:

cloudAgentId

Authorization:

Request - None.

Response:

DELETE Delete Cloud Agent

URL:

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

URL Parameters:

cloudAgentId

Authorization:

Response:

Related content

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

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

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

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

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

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

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