Payload Capture REST API

Available payload capture actions via APIs

Get / Create / Delete / Force Delete payload 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/payloadCaptures

Post Retrieve All Payload Captures

URL:

POST - https://`{{dpodHostname}}`/op/api/v2/payloadCaptures/`{{productView}}`/search

URL Parameters:

Name	Is required	Description	Parameter Type	Data options

Name	Is required	Description	Parameter Type	Data options
productView	True	Product view APIC / IDG	String	APIC IDG

Authorization:

Required Permissions	More info

Required Permissions	More info
Access permissions for relevant product view Access permissions for payload capture Access permissions for investigate	See roles information here: Role Based Access Control

Response:

Response Type	Example value For IDG Product View	Description

Response Type

Example value For IDG Product View

Description

Successful

{
    "resultCode": "SUCCESS",
    "resultMessage": "Payload captures retrieved successfully",
    "result": {
        "totalResultsCount": 1,
        "startTimeInMillis": 0,
        "finishTimeInMillis": 0,
        "sampleTimeInMillis": 0,
        "results": [
            {
                "id": 6,
                "deviceName": "apic10_5_idg8",
                "domainName": "BankA_Domain",
                "startTimeInMillis": 1703084008888,
                "endTimeInMillis": 1703084308888,
                "contextId": "3084efbf-50b9-4899-8323-3ecad1d53cee",
                "userName": "admin",
                "captureMode": "IDG_AND_V5"
            }
        ]
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “Payload captures retrieved successfully"

Response Type	Example value For API-C Product View	Description

Response Type

Example value For API-C Product View

Description

Successful

{
    "resultCode": "SUCCESS",
    "resultMessage": "Payload captures retrieved successfully",
    "result": {
        "totalResultsCount": 1,
        "startTimeInMillis": 0,
        "finishTimeInMillis": 0,
        "sampleTimeInMillis": 0,
        "results": [
            {
                "id": 9,
                "deviceName": "apic10_5_idg8",
                "domainName": "APIMgmt_C777777777",
                "catalogName": "bankcatalog",
                "startTimeInMillis": 1703085442515,
                "contextId": "37163da7-706a-4364-9e8b-65cd1608dc54",
                "userName": "admin",
                "captureMode": "V6",
                "oldAnalyticsEndpoint": "mscAnalyticsEndpoint",
                "collectionObjectName": "montierorg10_bankcatalog_collection"
            }
        ]
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “Payload captures retrieved successfully"

GET Get Specific Payload Capture Details

URL:

GET - https://`{{dpodHostname}}`/op/api/v2/payloadCapture/`{{productView}}`/`{{payloadCaptureId}}`

URL Parameters:

Name	Is required	Description	Parameter Type

Name	Is required	Description	Parameter Type
productView	True	Product view APIC / IDG	String
payloadCaptureId	True	The payload capture id (can be retrieved from “Retrieved all API-C payload captures” response)	Number

Authorization:

Required Permissions	More info

Required Permissions	More info
Access permissions for relevant product view Access permissions for payload capture Access permissions for investigate	See roles information here: Role Based Access Control

Response:

Response Type	Example value For IDG Product View	Description

Response Type

Example value For IDG Product View

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “Payload capture retrieved successfully”

Response Type	Example value For APIC Product View	Description

Response Type

Example value For APIC Product View

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “Payload capture retrieved successfully”

POST Add Payload Capture

URL:

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

URL Parameters:

Name	Is required	Description	Parameter Type	Data options

Name	Is required	Description	Parameter Type	Data options
productView	True	Product view APIC / IDG	String	APIC IDG

Authorization:

Required Permissions	More info

Required Permissions	More info
Access permissions for relevant product view Access permissions for payload capture Access permissions for investigate	See roles information here:

Request body:

Type	Parameters	Example Json for Gateway Payload Capture	Description

Type	Parameters	Example Json for Gateway Payload Capture	Description
Required	String `payloadCaptureMode` List<Filter> filters Long `duration`		`payloadCaptureMode` types: IDG_AND_V5 V6 Filters Object Example: `duration` is is limited to 10 minutes and is only relevant for payloadCaptureMode = IDG_AND_V5

Response:

Response Type	Example value For IDG Product View	Description

Response Type

Example value For IDG Product View

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “All subscriptions created successfully”

Partial success

Status code: 200

resultCode → WARNING

resultErrorCode → SOME_SUBSCRIPTIONS_FAILED

resultMessage → “Some subscriptions created successfully”

Failure

Status code: 200

resultCode → ERROR

resultErrorCode → ALL_SUBSCRIPTIONS_FAILED

resultMessage → “All subscriptions failed”

Type	Parameters	Example Json for APIC Payload Capture	Description

Type	Parameters	Example Json for APIC Payload Capture	Description
Required	String `payloadCaptureMode` List<Filter> filters Long `duration`		`payloadCaptureMode` types: IDG_AND_V5 V6 Filters Object Example: Filter field DPOD_DEVICE_NAME and DPOD_DOMAIN_NAME are always required For V6 capture mode, filter field DPOD_APIC_CATALOG is required

Response Type	Example value For APIC Product View	Description

Response Type

Example value For APIC Product View

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “All subscriptions created successfully”

Partial success

Status code: 200

resultCode → WARNING

resultErrorCode → SOME_SUBSCRIPTIONS_FAILED

resultMessage → “Some subscriptions created successfully”

Failure

Status code: 200

resultCode → ERROR

resultErrorCode → ALL_SUBSCRIPTIONS_FAILED

resultMessage → “All subscriptions failed”

DELETE Delete Payload Capture

URL:

DELETE - https://`{{dpodHostname}}`/op/api/v2/payloadCapture/`{{productView}}`/`{{payloadCaptureId}}`

URL Parameters:

Name	Is required	Description	Parameter Type

Name	Is required	Description	Parameter Type
productView	True	Product view APIC / IDG	String
payloadCaptureId	True	The payload capture id (can be retrieved from “Retrieved all API-C payload captures” response)	Number

Authorization:

Required Permissions	More info

Required Permissions	More info
Access permissions for relevant product view Access permissions for payload capture Access permissions for investigate	See roles information here:

Response:

Response Type	Example value For IDG Product View	Description

Response Type

Example value For IDG Product View

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “Payload capture stopped successfully”

Response Type	Example value For APIC Product View	Description

Response Type

Example value For APIC Product View

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “Payload capture stopped successfully”

POST Force Delete Payload Capture

URL:

POST - https://`{{dpodHostname}}`/op/api/v2/payloadCapture/`{{productView}}`/`{{payloadCaptureId}}`/forceDelete

URL Parameters:

Name	Is required	Description	Parameter Type

Name	Is required	Description	Parameter Type
productView	True	Product view APIC / IDG	String
payloadCaptureId	True	The payload capture id (can be retrieved from “Retrieved all API-C payload captures” response)	Number

Authorization:

Required Permissions	More info

Required Permissions	More info
Access permissions for relevant product view Access permissions for payload capture Access permissions for investigate	See roles information here:

Response:

Response Type	Example value for IDG Product View	Description

Response Type

Example value for IDG Product View

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “: Payload capture deleted successfully”

Response Type	Example value for APIC Product View	Description

Response Type

Example value for APIC Product View

Description

Successful

Status code: 200

resultCode → SUCCESS

resultMessage → “: Payload capture deleted successfully”

IBM DPOD v1.0.20.x

IBM DataPower Operations Dashboard v1.0.20.x

Payload Capture REST API

Available payload capture actions via APIs

Authorization:

From CLI (example):

Post Retrieve All Payload Captures

URL:

POST - https://`{{dpodHostname}}`/op/api/v2/payloadCaptures/`{{productView}}`/search

URL Parameters:

Authorization:

Response:

GET Get Specific Payload Capture Details

URL:

GET - https://`{{dpodHostname}}`/op/api/v2/payloadCapture/`{{productView}}`/`{{payloadCaptureId}}`

URL Parameters:

payloadCaptureId

Authorization:

Response:

POST Add Payload Capture

URL:

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

URL Parameters:

Authorization:

Request body:

Response:

DELETE Delete Payload Capture

URL:

DELETE - https://`{{dpodHostname}}`/op/api/v2/payloadCapture/`{{productView}}`/`{{payloadCaptureId}}`

URL Parameters:

Authorization:

Response:

POST Force Delete Payload Capture

URL:

POST - https://`{{dpodHostname}}`/op/api/v2/payloadCapture/`{{productView}}`/`{{payloadCaptureId}}`/forceDelete

URL Parameters:

Authorization:

Response:

IBM DataPower Operations Dashboard v1.0.20.x

Available payload capture actions via APIs

Authorization:

From CLI (example):

Post Retrieve All Payload Captures

URL:

POST - https://{{dpodHostname}}/op/api/v2/payloadCaptures/{{productView}}/search

URL Parameters:

Authorization:

Response:

GET Get Specific Payload Capture Details

URL:

GET - https://{{dpodHostname}}/op/api/v2/payloadCapture/{{productView}}/{{payloadCaptureId}}

URL Parameters:

payloadCaptureId

Authorization:

Response:

POST Add Payload Capture

URL:

POST - https://{{dpodHostname}}/op/api/v2/payloadCaptures/{{productView}}

URL Parameters:

Authorization:

Request body:

Response:

DELETE Delete Payload Capture

URL:

DELETE - https://{{dpodHostname}}/op/api/v2/payloadCapture/{{productView}}/{{payloadCaptureId}}

URL Parameters:

Authorization:

Response:

POST Force Delete Payload Capture

URL:

POST - https://{{dpodHostname}}/op/api/v2/payloadCapture/{{productView}}/{{payloadCaptureId}}/forceDelete

URL Parameters:

Authorization:

Response:

POST - https://`{{dpodHostname}}`/op/api/v2/payloadCaptures/`{{productView}}`/search

GET - https://`{{dpodHostname}}`/op/api/v2/payloadCapture/`{{productView}}`/`{{payloadCaptureId}}`

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

DELETE - https://`{{dpodHostname}}`/op/api/v2/payloadCapture/`{{productView}}`/`{{payloadCaptureId}}`

POST - https://`{{dpodHostname}}`/op/api/v2/payloadCapture/`{{productView}}`/`{{payloadCaptureId}}`/forceDelete