API-C Probe Capture REST API

Available API-C Probe capture actions via APIs

Get / Create / Delete API-C probe captures

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

GET Retrieve All API-C Probe Captures

URL:

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

Authorization:

Required Permissions	More info

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

Response:

Response Type	Example value	Description

Response Type

Example value

Description

Successful

{
    "resultCode": "SUCCESS",
    "resultMessage": "API probe captures retrieved successfully",
    "result": {
        "apicPayloadCaptures": [
            {
                "id": 1,
                "captureId": "4789432c-ba12-4b8b-8900-57c1dd72ba8a",
                "deviceName": "apic10_5_idg7",
                "domainName": "APIMgmt_C777777777",
                "captureCount": 5,
                "capturedTransactions": 5,
                "userName": "admin",
                "startTimeInMill": 1702972400560,
                "endTimeInMill": 1702972438719,
                "captureStatus": "COMPLETED"
            }
        ]
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “API probe captures retrieved successfully"

GET Get Specific API-C Probe Capture Details

URL:

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

URL Parameters:

Name	Is required	Description	Parameter Type

Name	Is required	Description	Parameter Type
apiProbeCaptureId	True	The API probe capture id (can be retrieved from “Retrieved all API-C probe captures” response)	Number

Authorization:

Required Permissions	More info

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

Response:

Response Type	Example value	Description

Response Type

Example value

Description

Successful

{
    "resultCode": "SUCCESS",
    "resultMessage": "API probe payload capture retrieved successfully",
    "result": {
        "id": 1,
        "captureId": "4789432c-ba12-4b8b-8900-57c1dd72ba8a",
        "deviceName": "apic10_5_idg7",
        "domainName": "APIMgmt_C777777777",
        "captureCount": 5,
        "capturedTransactions": 5,
        "userName": "admin",
        "startTimeInMill": 1702972400560,
        "endTimeInMill": 1702972438719,
        "captureStatus": "COMPLETED"
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “API probe payload capture retrieved successfully”

Failure

Status code: 200

resultCode → ERROR

resultErrorCode → NOT_FOUND

resultMessage → “API-C payload capture not found”

POST Add API-C Probe Capture

URL:

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

Authorization:

Required Permissions	More info

Required Permissions	More info
Access permissions for API-C product view Access permissions for API probe capture 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	List<String>`deviceNames` String `deviceNamesOperator` List<String>`domainNames` String `domainNamesOperator`		`deviceNames and domainNames`→ support wildcards. `deviceNamesOperator, domainNamesOperator and catalogNamesOperator` must be `eq`.
Optional	Long durationInMinutes Long captureCount Long interval Boolean debugHeader String logLevel Map<String, String> additionalFiltersParameters		The duration in minutes to capture should be a positive number The number of transactions to capture should be a positive number The interval in seconds between which the data for two consecutive transactions can be captured is between 1 - 3600 `additionalFiltersParameters`→ List of filters. List can be sent empty.

Response:

Response Type	Example value	Description

Response Type

Example value

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “All API probe captures created successfully”

Partial success

Status code: 200

resultCode → WARNING

resultErrorCode → SOME_CAPTURES_FAILED

resultMessage → “Some API probe captures created successfully”

Failure

Status code: 200

resultCode → ERROR

resultErrorCode → ALL_CAPTURES_FAILED

resultMessage → “All API probe captures failed”

DELETE Delete API-C Probe Capture

URL:

DELETE - https://`{{dpodHostname}}`/op/api/v2/apiProbeCapture/`{{apiProbeCaptureId}}`

URL Parameters:

Name	Is required	Description	Parameter Type

Name	Is required	Description	Parameter Type
apiProbeCaptureId	True	The API probe capture id (can be retrieved from “Retrieved all API-C probe captures” response)	Number

Authorization:

Required Permissions	More info

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

Response:

Response Type	Example value	Description

Response Type

Example value

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “API probe capture is stopping”

IBM DPOD v1.0.20.x

IBM DataPower Operations Dashboard v1.0.20.x

API-C Probe Capture REST API

Analytics

Available API-C Probe capture actions via APIs

Authorization:

From CLI (example):

GET Retrieve All API-C Probe Captures

URL:

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

Authorization:

Response:

GET Get Specific API-C Probe Capture Details

URL:

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

URL Parameters:

apiProbeCaptureId

Authorization:

Response:

POST Add API-C Probe Capture

URL:

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

Authorization:

Request body:

Response:

DELETE Delete API-C Probe Capture

URL:

DELETE - https://`{{dpodHostname}}`/op/api/v2/apiProbeCapture/`{{apiProbeCaptureId}}`

URL Parameters:

Authorization:

Response:

Related content

IBM DataPower Operations Dashboard v1.0.20.x

API-C Probe Capture REST API

Available API-C Probe capture actions via APIs

Authorization:

From CLI (example):

GET Retrieve All API-C Probe Captures

URL:

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

Authorization:

Response:

GET Get Specific API-C Probe Capture Details

URL:

GET - https://{{dpodHostname}}/op/api/v2/apiProbeCapture/{{apiProbeCaptureId}}

URL Parameters:

apiProbeCaptureId

Authorization:

Response:

POST Add API-C Probe Capture

URL:

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

Authorization:

Request body:

Response:

DELETE Delete API-C Probe Capture

URL:

DELETE - https://{{dpodHostname}}/op/api/v2/apiProbeCapture/{{apiProbeCaptureId}}

URL Parameters:

Authorization:

Response:

Related content

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

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

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

DELETE - https://`{{dpodHostname}}`/op/api/v2/apiProbeCapture/`{{apiProbeCaptureId}}`