Page Comparison

...

Available API-C Probe capture actions via APIs

Get / Create / Delete / Force Delete API-C probe captures

...

Expand

title	/op/api/v2/apiProbeCaptures/

URL:

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

Authorization:

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

Successful

Code Block

language	json

{
    "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"

...

Expand

title	/op/api/v2/apiProbeCapture/{{apiProbeCaptureId}}

URL:

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

URL Parameters:

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

Successful

Code Block

language	json

{
    "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

Code Block

language	json

{
    "resultCode": "ERROR",
    "resultErrorCode": "NOT_FOUND",
    "resultMessage": "API-C payload capture not found"
}

Status code: 200

resultCode → ERROR

resultErrorCode → NOT_FOUND

resultMessage → “API-C payload capture not found”

...

Expand

title	/op/api/v2/apiProbeCaptures/

URL:

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

Authorization:

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

Required

List<String>deviceNames
String deviceNamesOperator
List<String>domainNames
String domainNamesOperator

Code Block

language	json

{
    "deviceNames": [
        "apic10_5_idg7"
    ],
    "deviceNamesOperator": "eq",
    "domainNames": [
        "APIMgmt_C777777777"
    ],
    "domainNamesOperator": "eq",
    "catalogNames": [
        "bankcatalog",
        "montiercatalog"
    ],
    "catalogNamesOperator": "eq"
}

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

Code Block

{
    "deviceNames": [
        "apic10_5_idg7"
    ],
    "deviceNamesOperator": "eq",
    "domainNames": [
        "APIMgmt_C777777777"
    ],
    "domainNamesOperator": "eq",
    "durationInMinutes": 60,
    "captureCount": 5,
    "interval": 1,
    "debugHeader": false,
    "logLevel": "debug",
    "additionalFiltersParameters" : {
      "apicCatalogName":"bankcatalog", 
      "apicApiName":"balance-convert", 
      "clientIp":"172.17.100.131",
      "apicClientId":"b580876c023e5936fe622da39d78142a",
      "apicFullUri": "/montierorg10/bankcatalog/balance-convert-102/convert"
    }
}

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

Successful

Code Block

language	json

{
    "resultCode": "SUCCESS",
    "resultMessage": "All API probe captures created successfully",
    "result": {
        "apicPayloadCaptures": [
            {
                "id": 3,
                "captureId": "f705e48f-5601-441a-b4bc-57c1dd72cb34",
                "deviceName": "apic10_5_idg7",
                "domainName": "APIMgmt_C777777777",
                "captureCount": 100,
                "capturedTransactions": 0,
                "userName": "admin",
                "startTimeInMill": 1702976576044,
                "captureStatus": "ACTIVE",
                "resultCode": "SUCCESS",
                "resultMessage": "API probe capture created successfully"
            }
        ]
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “All API probe captures created successfully”

Partial success

Code Block

language	json

{
    "resultCode": "WARNING",
    "resultErrorCode": "SOME_CAPTURES_FAILED",
    "resultMessage": "Some API probe captures created successfully",
    "result": {
        "apicPayloadCaptures": [
            {
                "deviceName": "apic10_5_idg8",
                "domainName": "APIMgmt_C777777777",
                "resultCode": "ERROR",
                "resultErrorCode": "NO_ROMA_PORT_DEFINED_FOR_DEVICE",
                "resultMessage": "No ROMA port defined for this device"
            },
            {
                "id": 4,
                "captureId": "8aea845a-380e-40af-89d1-57c1dd72405a",
                "deviceName": "apic10_5_idg7",
                "domainName": "APIMgmt_C777777777",
                "captureCount": 100,
                "capturedTransactions": 0,
                "userName": "admin",
                "startTimeInMill": 1702976632734,
                "captureStatus": "ACTIVE",
                "resultCode": "SUCCESS",
                "resultMessage": "API probe capture created successfully"
            }
        ]
    }
}

Status code: 200

resultCode → WARNING

resultErrorCode → SOME_CAPTURES_FAILED

resultMessage → “Some API probe captures created successfully”

Failure

Code Block

language	json

{
    "resultCode": "ERROR",
    "resultErrorCode": "ALL_CAPTURES_FAILED",
    "resultMessage": "All API probe captures failed",
    "result": {
        "apicPayloadCaptures": [
            {
                "deviceName": "apic10_5_idg8",
                "domainName": "APIMgmt_C777777777",
                "resultCode": "ERROR",
                "resultErrorCode": "NO_ROMA_PORT_DEFINED_FOR_DEVICE",
                "resultMessage": "No ROMA port defined for this device"
            }
        ]
    }
}

Status code: 200

resultCode → ERROR

resultErrorCode → ALL_CAPTURES_FAILED

resultMessage → “All API probe captures failed”

...

Expand

title	/op/api/v2/apiProbeCapture/{{apiProbeCaptureId}}

URL:

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

URL Parameters:

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

Successful

Code Block

language	json

{
    "resultCode": "SUCCESS",
    "resultMessage": "API probe capture is stopping"
}

Status code: 200

resultCode → SUCCESS

resultMessage → “API probe capture is stopping”

...

Version	Old Version 1	New Version Current
Changes made by	Sara Weisz	Sara Weisz
Saved on	Dec 19, 2023	Dec 19, 2023

Versions Compared

Key

Available API-C Probe capture actions via APIs

URL:

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

Authorization:

Response:

URL:

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

URL Parameters:

apiProbeCaptureId

Authorization:

Response:

URL:

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

Authorization:

Request body:

Response:

URL:

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

URL Parameters:

Authorization:

Response:

Page Comparison

Versions Compared

Key

Available API-C Probe capture actions via APIs

URL:

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

Authorization:

Response:

URL:

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

URL Parameters:

apiProbeCaptureId

Authorization:

Response:

URL:

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

Authorization:

Request body:

Response:

URL:

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

URL Parameters:

Authorization:

Response:

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}}`