IBM DataPower Operations Dashboard v1.0.22.x
Probe Capture REST API
Sara Weisz
In this page:
POST Search for Probe Captures
Description:
This API performs a search for probe captures.
Required Roles:
There is no custom role that denies access to “Manage Probe“.
And one of the following:
A custom role that allows access to “Manage Probe“.
The OpDashAdminRole builtin role.
URI:
/op/api/v2/probeCaptures/search
Request:
The request should use the POST method with the following fields in its body:
Name | Required/Optional | Description | Type | Available Options |
|---|
Name | Required/Optional | Description | Type | Available Options |
|---|---|---|---|---|
pagingDto | Required | Navigate between a set of search results. For further details see Search Request. | Element |
|
filters | Optional | Filter criteria for the search results. For further details see Search Request. | Element |
|
filters[].filterfield | Required | Specifies the filter field name. | String |
|
filters[filterfield=DPOD_API_PROBE_CAPTURE_STATUS].stringValues | Required | The status of the probe. | Array of Strings |
|
Example:
{
"pagingDto": {
"pagingMinRecordNum": 1,
"pagingMaxRecordNum": 100
},
"filters": [
{
"filterField": "DPOD_DEVICE_NAME",
"filterOperator": "EQUALS",
"stringValues": [
"idg_10_6_0_a"
]
},
{
"filterField": "DPOD_DOMAIN_NAME",
"filterOperator": "EQUALS",
"stringValues": [
"BankA_Domain"
]
},
{
"filterField": "DPOD_SERVICE_NAME",
"filterOperator": "EQUALS",
"stringValues": [
"YellowPagesService.WSP"
]
},
{
"filterField": "DPOD_API_PROBE_CAPTURE_ID",
"filterOperator": "EQUALS",
"stringValues": [
"f5940035-9c29-4e25-8b96-0fe76ecc947c"
]
},
{
"filterField": "DPOD_API_PROBE_CAPTURE_STATUS",
"filterOperator": "EQUALS",
"stringValues": [
"ACTIVE"
]
}
]
}Successful Response:
The response includes the following fields in its result element:
Name | Description | Type | Available Options |
|---|
Name | Description | Type | Available Options |
|---|---|---|---|
totalResultsCount | The total number of records. | Long |
|
results |
| Array of Element |
|
results[].id | The ID of the probe capture. | Long |
|
results[].captureId | The ID of the probe capture in the DataPower gateway. | String |
|
results[].deviceName | The device name from which the probe data was captured. | String |
|
results[].domainName | The domain name from which the probe data was captured. | String |
|
results[].serviceName | The service name from which the debug probe data was captured. | String |
|
results[].captureCount | The number of transactions to capture. | Long |
|
results[].capturedTransactions | The number of captured transactions. | Long |
|
results[].userName | The user name who created the probe capture. | String |
|
results[].startTimeInMill | When the probe capture started. | Long |
|
results[].endTimeInMill | When the probe capture finished. | Long |
|
results[].httpHeaderName | The transaction HTTP header name. | String |
|
results[].clientIp | The transaction client IP. | String |
|
results[].fullUri | The transaction full URI. | String |
|
results[].captureStatus | The probe capture status. | String |
|
Example:
{
"resultCode": "SUCCESS",
"resultMessage": "Probe captures retrieved successfully",
"result": {
"totalResultsCount": 1,
"results": [
{
"id": 151,
"captureId": "f5940035-9c29-4e25-8b96-0fe76ecc947c",
"deviceName": "idg_10_6_0_a",
"domainName": "BankA_Domain",
"serviceName": "YellowPagesService.WSP",
"captureCount": 10,
"capturedTransactions": 10,
"userName": "admin",
"startTimeInMill": 1727249223659,
"endTimeInMill": 1727249593870,
"captureStatus": "COMPLETED"
}
]
}
}GET Get a Probe Capture
Description:
This API retrieves a specific probe capture.
Required Roles:
There is no custom role that denies access to “Manage Probe“.
And one of the following:
A custom role that allows access to “Manage Probe“.
The OpDashAdminRole builtin role.
URI:
/op/api/v2/probeCapture/{{probeCaptureId}}
Request:
The request should use the GET method with the following URL parameters:
Name | Required/Optional | Description | Type | Available Options |
|---|
Name | Required/Optional | Description | Type | Available Options |
|---|---|---|---|---|
probeCaptureId | Required | The probe capture ID. | Long |
|
Successful Response:
The response includes the following in its result element:
Name | Description | Type | Available Options |
|---|
Name | Description | Type | Available Options |
|---|---|---|---|
id | The ID of the probe capture. | Long |
|
captureId | The ID of the probe capture in the DataPower gateway. | String |
|
deviceName | The device name from which the probe data was captured. | String |
|
domainName | The domain name from which the probe data was captured. | String |
|
serviceName | The service name from which the debug probe data was captured. | String |
|
captureCount | The number of transactions to capture. | Long |
|
capturedTransactions | The number of captured transactions. | Long |
|
userName | The user name who created the probe capture. | String |
|
startTimeInMill | When the probe capture started. | Long |
|
endTimeInMill | When the probe capture finished. | Long |
|
httpHeaderName | The transaction HTTP header name. | String |
|
clientIp | The transaction client IP. | String |
|
fullUri | The transaction full URI. | String |
|
captureStatus | The probe capture status. | String |
|
Example:
{
"resultCode": "SUCCESS",
"resultMessage": "Probe capture retrieved successfully",
"result": {
"id": 151,
"captureId": "f5940035-9c29-4e25-8b96-0fe76ecc947c",
"deviceName": "idg_10_6_0_a",
"domainName": "BankA_Domain",
"serviceName": "YellowPagesService.WSP",
"captureCount": 10,
"capturedTransactions": 10,
"userName": "admin",
"startTimeInMill": 1727249223659,
"endTimeInMill": 1727249593870,
"captureStatus": "COMPLETED"
}
}POST Add Probe Captures
Description:
This API adds probe captures.
Required Roles:
There is no custom role that denies access to “Manage Probe“.
And one of the following:
A custom role that allows access to “Manage Probe“.
The OpDashAdminRole builtin role.
URI:
/op/api/v2/probeCaptures
Request:
The request should use the POST method with the following fields in its body:
Name | Required/Optional | Description | Type | Available Options |
|---|
Name | Required/Optional | Description | Type | Available Options |
|---|---|---|---|---|
deviceNames | Required | The device names on which to create a probe capture. | Array of Strings | Supports wildcards |
deviceNamesOperator | Required | The device names operator. | String |
|
domainNames | Required | The domain names on which to create a probe capture. | Array of Strings | Supports wildcards |
domainNamesOperator | Required | The domain names operator. | String |
|
serviceNames | Required | The service names on which to create a probe capture. | Array of Strings | Supports wildcards |
serviceNameOperator | Required | The service names operator. | Array of Strings |
|
durationInMinutes | Required | The duration in minutes to capture. | Long | Positive number |
captureCount | Required | The number of transactions to capture. | Long | Number between 10 - 200 |
interval | Optional | The interval in seconds between which the data for two consecutive transactions can be captured. | Long | Number between 1 - 3600 |
additionalFiltersParameters | Optional | Probe transaction filters. | Element |
|
additionalFiltersParameters.httpHeaderName | Optional | Filter transactions by the HTTP header name. | String |
|
additionalFiltersParameters.clientInUri | Optional | Filter transactions by the client IP address. | String |
|
additionalFiltersParameters.clientIp | Optional | Filter transactions by the request URI path. | String |
|
Example:
Successful Response:
The response includes the following fields in its result element:
Name | Description | Type | Available Options |
|---|
Name | Description | Type | Available Options |
|---|---|---|---|
probeCaptures | The probe captures that have been created. | Array of Elements |
|
probeCaptures[].id | The ID of the probe capture. | Long |
|
probeCaptures[].captureId | The ID of the probe capture in the DataPower gateway. | String |
|
probeCaptures[].deviceName | The device name from which the probe data was captured. | String |
|
probeCaptures[].domainName | The domain name from which the probe data was captured. | String |
|
probeCaptures[].serviceName | The service name from which the debug probe data was captured. | String |
|
probeCaptures[].captureCount | The number of transactions to capture. | Long |
|
probeCaptures[].capturedTransactions | The number of captured transactions. | Long |
|
probeCaptures[].userName | The user name who created the probe capture. | String |
|
probeCaptures[].startTimeInMill | When the probe capture started. | Long |
|
probeCaptures[].endTimeInMill | When the probe capture finished. |
|
|
probeCaptures[].httpHeaderName | The transaction HTTP header name. | String |
|
probeCaptures[].clientIp | The transaction client IP. | String |
|
probeCaptures[].fullUri | The transaction full URI. | String |
|
probeCaptures[].captureStatus | The probe capture status. | String |
|
probeCaptures[].resultCode | The probe capture creation result code. | String |
|
probeCaptures[].resultMessage | The probe capture creation result message. | String |
|
Example:
DELETE Delete a Probe Capture
Description:
This API marks a specific probe capture for deletion (with a status of STOPPING).
A background process will delete the probe capture from the DataPower gateway and will change its status to STOPPED once it is deleted.
Required Roles:
There is no custom role that denies access to “Manage Probe“.
And one of the following:
A custom role that allows access to “Manage Probe“.
The OpDashAdminRole builtin role.
URI:
/op/api/v2/probeCapture/{{probeCaptureId}}
Request:
The request should use the DELETE method with the following URL parameters:
Name | Required/Optional | Description | Type | Available Options |
|---|
Name | Required/Optional | Description | Type | Available Options |
|---|---|---|---|---|
probeCaptureId | Required | The probe capture ID. | Long |
|
Successful Response:
Example:
Copyright © 2015 MonTier Software (2015) Ltd.