API-C Probe Settings REST API

Available API-C Probe settings actions via APIs

Configure API-C probe settings

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/apiProbeSettings

POST Configure API-C Probe Settings

URL:

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

Authorization:

Required Permissions	More info

Required Permissions	More info
Access permissions for API-C product view Access permissions for API probe Access permissions for investigate	See roles information here: Role Based Access Control

Request body:

Type	Parameters	Example Json	Description

Type	Parameters	Example Json	Description
Required	String `deviceName` String`domainName` String `gatewayPeering`	`{ deviceName: "apic10_5_idg7", domainName: "APIMgmt_C777777777", gatewayPeering: "API.probe" }`

Response:

Response Type	Example value	Description

Response Type

Example value

Description

Successful

{
    "resultCode": "SUCCESS",
    "resultMessage": "API Probe Settings successfully configured."
}

Status code: 200

resultCode → SUCCESS

resultMessage → “API Probe Settings successfully configured”

IBM DPOD v1.0.20.x

IBM DataPower Operations Dashboard v1.0.20.x

API-C Probe Settings REST API

Analytics

Available API-C Probe settings actions via APIs

Authorization:

From CLI (example):

POST Configure API-C Probe Settings

URL:

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

Authorization:

Request body:

Response:

Related content

IBM DataPower Operations Dashboard v1.0.20.x

API-C Probe Settings REST API

Available API-C Probe settings actions via APIs

Authorization:

From CLI (example):

POST Configure API-C Probe Settings

URL:

POST - https://{{dpodHostname}}/op/api/v2/apiProbeSettings/configure

Authorization:

Request body:

Response:

Related content

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