/
API-C Probe Settings REST API

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.

API-C Probe Settings REST API

Owned by Sara Weisz
Dec 18, 2023
1 min read

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

  1. Access permissions for API-C product view

  2. Access permissions for API probe

  3. 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

  1. String deviceName

  2. StringdomainName

  3. 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”

 

Copyright © 2015 MonTier Software (2015) Ltd.