- Created by Sara Weisz, last modified by Amit Munwes on Sept 30, 2024
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 10 Next »
In this page:
POST Search API Probe Captures
Description:
This API performs a search for API probe captures.
Required Roles:
There is no custom role that denies access to “Manage API Probe“.
And one of the following:
A custom role that allows access to “Manage API Probe“.
The OpDashAdminRole builtin role.
URI:
/op/api/v2/apiProbeCaptures/search
Request:
The request should use the POST method with the following fields in its body:
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 API probe. | String |
|
Example:
{ "pagingDto": { "pagingMinRecordNum": 1, "pagingMaxRecordNum": 100 }, "filters": [ { "filterField": "DPOD_DEVICE_NAME", "filterOperator": "EQUALS", "stringValues": [ "idg_10_5_0_a" ] }, { "filterField": "DPOD_DOMAIN_NAME", "filterOperator": "EQUALS", "stringValues": [ "APIC_Mgmt_Domain" ] }, { "filterField": "DPOD_API_PROBE_CAPTURE_ID", "filterOperator": "EQUALS", "stringValues": [ "60e634cf-e08f-4ee1-bc4e-fa26e6b933df" ] }, { "filterField": "DPOD_API_PROBE_CAPTURE_STATUS", "filterOperator": "EQUALS", "stringValues": [ "ACTIVE" ] } ] }
Successful Response:
The response includes the following fields in its body:
Name | Description | Type | Available Options |
---|---|---|---|
totalResultsCount | The total number of records. | Long |
|
results |
| Array of Element |
|
results[].id | The ID of the record in the Database. | Long |
|
results[].captureId | The ID of the API probe capture in the DataPower gateway. | String |
|
results[].deviceName | The device name from which the API probe data was captured. | String |
|
results[].domainName | The domain name from which the API 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 API probe capture. | String |
|
results[].startTimeInMill | When the API probe capture started. | Long |
|
results[].endTimeInMill | When the API probe capture finished. | Long |
|
results[].captureStatus | The API probe capture status. | String |
|
Example:
{ "resultCode": "SUCCESS", "resultMessage": "API Probe captures retrieved successfully", "result": { "totalResultsCount": 1, "results": [ { "id": 162, "captureId": "60e634cf-e08f-4ee1-bc4e-fa26e6b933df", "deviceName": "idg_10_5_0_a", "domainName": "APIC_Mgmt_Domain", "captureCount": 15, "capturedTransactions": 7, "userName": "admin", "startTimeInMill": 1727265545369, "captureStatus": "ACTIVE" } ] } }
GET Get an API Probe Capture
Description:
This API retrieves a specific API probe capture.
Required Roles:
There is no custom role that denies access to “Manage API Probe“.
And one of the following:
A custom role that allows access to “Manage API Probe“.
The OpDashAdminRole builtin role.
URI:
/op/api/v2/apiProbeCapture/{{apiProbeCaptureId}}
Request:
The request should use the GET method with the following URL parameters:
Name | Required/Optional | Description | Type | Available Options |
---|---|---|---|---|
apiProbeCaptureId | Required | The API probe capture ID (can be retrieved from the “Search API Probe Captures” response) | Element |
|
Successful Response:
The response includes the following fields in its body:
Name | Description | Type | Available Options |
---|---|---|---|
id | The id of the record in the Database. | Long |
|
captureId | The id for a transaction API-C probe capture. | String |
|
deviceName | The device name from which the debug API-C probe data was captured. | String |
|
domainName | The domain name from which the debug API-C 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 capture. | String |
|
startTimeInMill | When the capture started. | Long |
|
endTimeInMill | When the capture finished. | Long |
|
captureStatus | The capture status. | String |
|
Example:
{ "resultCode": "SUCCESS", "resultMessage": "API Probe capture retrieved successfully", "result": { "id": 162, "captureId": "60e634cf-e08f-4ee1-bc4e-fa26e6b933df", "deviceName": "idg_10_5_0_a", "domainName": "APIC_Mgmt_Domain", "captureCount": 15, "capturedTransactions": 15, "userName": "admin", "startTimeInMill": 1727265545369, "endTimeInMill": 1727265676462, "captureStatus": "COMPLETED" } }
POST Add API-C Probe Capture
Description:
This API addsl API-C probe captures.
Required Roles:
There shouldn’t be defined a custom role that denies access to “Manage API Probe“ and there is a custom role that permits access or a built-in role OpDashAdminRole.
URI:
/op/api/v2/apiProbeCaptures/
Request:
The request should use the POST method with the following fields in its body:
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 |
|
durationInMinutes | Required | the duration in minutes to capture. | Long | Positive number |
captureCount | Required | The number of transactions to capture. | Long | Number between 1 - 1000 |
interval | Optional | The interval in seconds between which the data for two consecutive transactions can be captured. | Long | Number between 1 - 3600 |
debugHeader | Optional | Indicates to capture only transactions that include the | Boolean |
|
logLevel | Optional | The log level of the probe data to be captured. | String |
|
additionalFiltersParameters | Optional | API-C Probe Filters. | Element |
|
additionalFiltersParameters.apicApiName | Optional | Filter transactions by the API name. | String |
|
additionalFiltersParameters.apicCatalogName | Optional | Filter transactions by the client IP address. | String |
|
additionalFiltersParameters.clientIp | Optional | Filter transactions by the client IP address. | String |
|
additionalFiltersParameters.apicClientId | Optional | Filter transactions by the client ID address. | String |
|
additionalFiltersParameters.apicFullUri | Optional | Filter transactions by the request full URI path. | String |
|
Example:
{ "deviceNames": [ "idg_10_5_0_a" ], "deviceNamesOperator": "eq", "domainNames": [ "APIC_Mgmt_Domain" ], "domainNamesOperator": "eq", "durationInMinutes": 60, "captureCount": 100, "interval": 1, "debugHeader": false, "logLevel": "debug", "additionalFiltersParameters": { "apicApiName": "", "apicCatalogName": "", "apicClientId": "", "apicFullUri": "" } }
Successful Response:
The response includes the following fields in its body:
Name | Description | Type | Available Options |
---|---|---|---|
apiProbeCaptures |
| Array of Element |
|
apiProbeCaptures.id | The id of the record in the Database. | Long |
|
apiProbeCaptures.captureId | The id for a transaction probe capture. | String |
|
apiProbeCaptures.deviceName | The device name from which the debug API-C probe data was captured. | String |
|
apiProbeCaptures.domainName | The domain name from which the debug API-C probe data was captured. | String |
|
apiProbeCaptures.captureCount | The number of transactions to capture. | Long |
|
apiProbeCaptures.capturedTransactions | The number of captured transactions. | Long |
|
apiProbeCaptures.userName | The user name who created the capture. | String |
|
apiProbeCaptures.startTimeInMill | When the capture started. | Long |
|
apiProbeCaptures.captureStatus | The capture status. | String |
|
apiProbeCaptures.resultCode | The REST API result code. | String |
|
apiProbeCaptures.resultMessage | The REST API result message. | String |
|
Example:
{ "resultCode": "SUCCESS", "resultMessage": "All API probe captures created successfully", "result": { "apiProbeCaptures": [ { "id": 165, "captureId": "1e070084-56a3-4464-9c09-fa26e6b9ab06", "deviceName": "idg_10_5_0_a", "domainName": "APIC_Mgmt_Domain", "captureCount": 100, "capturedTransactions": 0, "userName": "admin", "startTimeInMill": 1727267288816, "captureStatus": "ACTIVE", "resultCode": "SUCCESS", "resultMessage": "API Probe capture created successfully" } ] } }
DELETE Delete API-C Probe Capture
Description:
This API deletes a specific API-C probe capture.
Required Roles:
There shouldn’t be defined a custom role that denies access to “Manage API Probe“ and there is a custom role that permits access or a built-in role OpDashAdminRole.
URI:
/op/api/v2/apiProbeCapture/{{apiProbeCaptureId}}
Request:
The request should use the DELETE method with the following URL parameters:
Name | Required/Optional | Description | Type | Available Options |
---|---|---|---|---|
apiProbeCaptureId | Required | The API probe capture id (can be retrieved from “Retrieved all API-C probe captures” response) | Element |
|
Successful Response:
Example:
{ "resultCode": "SUCCESS", "resultMessage": "API probe capture is stopping" }
- No labels