/
API-C Analytics Payload Capture REST API

IBM DataPower Operations Dashboard v1.0.19.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

API-C Analytics Payload Capture REST API

Owned by Sara Weisz
Last updated: Apr 20, 2023 by Amit Munwes
3 min read

Available API-C Analytics payload capture actions via APIs

Get / Create / Delete / Force Delete API-C 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/apicPayloadCaptures

GET Retrieve All API-C Payload Captures

URL:

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

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. Access permissions for API-C product view

  2. Access permissions for payload capture

  3. 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-C payload captures retrieved successfully", "result": { "apicPayloadCaptures": [ { "id": 14, "deviceName": "apic10_5_idg7", "domainName": "APIMgmt_C777777777", "catalogName": "montiercatalog", "startTimeInMillis": 1681899542395, "contextId": "f739411f-25bc-4ad0-8447-c9ed9349f080", "userName": "admin", "collectionObjectName": "montierorg10_montiercatalog_collection" }, { "id": 13, "deviceName": "apic10_5_idg7", "domainName": "APIMgmt_C777777777", "catalogName": "bankcatalog", "startTimeInMillis": 1681899541941, "contextId": "9f244857-34ee-4e6f-92cf-b020a1d6f8ac", "userName": "admin", "collectionObjectName": "montierorg10_bankcatalog_collection" } ] } }

Status code: 200

resultCode → SUCCESS

resultMessage → “API-C payload captures retrieved successfully"

 

GET Get Specific API-C Payload Capture Details

URL:

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

URL Parameters:

Name

Is required

Description

Parameter Type

Name

Is required

Description

Parameter Type

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

  1. Access permissions for API-C product view

  2. Access permissions for payload capture

  3. 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-C payload capture retrieved successfully", "result": { "id": 14, "deviceName": "apic10_5_idg7", "domainName": "APIMgmt_C777777777", "catalogName": "montiercatalog", "startTimeInMillis": 1681899542395, "contextId": "f739411f-25bc-4ad0-8447-c9ed9349f080", "userName": "admin", "collectionObjectName": "montierorg10_montiercatalog_collection" } }

Status code: 200

resultCode → SUCCESS

resultMessage → “API-C payload capture retrieved successfully”

Failure

Status code: 200

resultCode → ERROR

resultErrorCode → NOT_FOUND

resultMessage → “API-C payload capture not found”

POST Add API-C Payload Capture

URL:

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

Authorization:

Required Permissions

More info

Required Permissions

More info

  1. Access permissions for API-C product view

  2. Access permissions for payload capture

  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. List<String>deviceNames

  2. String deviceNamesOperator

  3. List<String>domainNames

  4. String domainNamesOperator

  5. List<String> catalogNames

  6. String catalogNamesOperator

  1. deviceNames, domainNames and cataloNames→ support wildcards.

  2. deviceNamesOperator, domainNamesOperator and catalogNamesOperator must be eq.

Response:

Response Type

Example value

Description

Response Type

Example value

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 API-C Payload Capture

URL:

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

URL Parameters:

Name

Is required

Description

Parameter Type

Name

Is required

Description

Parameter Type

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

  1. Access permissions for API-C product view

  2. Access permissions for payload capture

  3. 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 → “Payload capture stopped successfully”

URL:

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

URL Parameters:

Name

Is required

Description

Parameter Type

Name

Is required

Description

Parameter Type

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

  1. Access permissions for API-C product view

  2. Access permissions for payload capture

  3. 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 → “Payload capture deleted successfully”

 

Copyright © 2015 MonTier Software (2015) Ltd.