Versions Compared

Old Version 9

changes.mady.by.user Sara Weisz

Saved on

compared with

New Version Current

changes.mady.by.user Sara Weisz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this page:

Table of Contents
minLevel1
maxLevel1
outlinefalse
styledisc
typelist
printabletrue

Status
colourYellow
titlePOST

...

Search for API

...

Probe Captures

Example:

Expand
title/op/api/v2/apiProbeCaptures/search

Description:

This API retrieves all API-C performs a search for API probe captures.

Required Roles:

  • There shouldn’t be defined a is no custom role that denies access to “Manage API -C Probe“ and there is a Probe“.

  • And one of the following:

    • A custom role that

    permits access or a built-in role OpDashAdminRole.

    • allows access to “Manage API Probe“.

    • The OpDashAdminRole builtin role.

URI:

/op/api/v2/apiProbeCaptures/search

Request:

The request should use the

Status
colourYellow
titlePOST
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 a set of criteria for the search results. For further details see Search Request.

Element

 

filters[].filterfield

  Required

Specifies the filter field name.

String

  • DPOD_DEVICE_NAME

  • DPOD_DOMAIN_NAME

  • DPOD_API_PROBE_CAPTURE_ID

  • DPOD_API_PROBE_CAPTURE_STATUS

filters[filterfield=DPOD_API_PROBE_CAPTURE_STATUS].stringValues

  Required

The maximum number of records to allow.Stringstatus of the API probe.

Array of Strings

  • ACTIVE

  • STOPPING

  • COMPLETED

  • ABORTED

pagingDto

Example:

Required

Navigate between a set of search results. For further details see Search Request.

Element

 

{
Code Block
Code Block
{
  "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 result element:

Name

Description

Type

Available Options

totalResultsCount

The total number of records.

Long

 

results

 

Array of Element

 

results[].id

The id ID of the record in the DatabaseAPI probe capture.

Long

 

results[].captureId

The id for a transaction API-C ID of the API probe capture in the DataPower gateway.

String

 

results[].deviceName

The device name from which the debug API -C probe data was captured.

String

 

results[].domainName

The domain name from which the debug API -C 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[].captureStatusThe capture statusapicApiName

The transaction API name.

String

results[].apicCatalogName

The transaction API catalog name.

String

  • ACTIVE

  • STOPPING

  • COMPLETED

  • ABORTED

Example:

Code Block{ "resultCode": "SUCCESS",

results[].clientIp

The transaction client IP address.

String

results[].apicClientId

The transaction client ID.

String

results[].apicFullUri

The transaction full URI path.

String

results[].captureStatus

The API probe capture status.

String

  • ACTIVE

  • STOPPING

  • COMPLETED

  • ABORTED

Example:

Code Block
{
    "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"
            }
        ]
    }
}

Status
colourGreen
titleGET
Get

...

an API

...

Probe Capture

...

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

Description:

This API retrieves a specific API -C probe capture.

Required Roles:

  • There shouldn’t be defined a is no custom role that denies access to “Manage API Probe“ and there is a .

  • And one of the following:

    • A custom role that

    permits access or a built-in role OpDashAdminRole

    • allows access to “Manage API Probe“.

    • The OpDashAdminRole builtin role.

URI:

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

Request:

The request should use the

Status
colourGreen
titleGET
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 probe captures” response)ElementID.

Long

 

Successful Response:

The response includes the following fields in its body result element:

Name

Description

Type

Available Options

id

The id ID of the record in the DatabaseAPI probe capture.

Long

 

captureId

The id for a transaction API-C ID of the API probe capture in the DataPower gateway.

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 API probe capture.

String

 

startTimeInMill

When the API probe capture started.

Long

 

endTimeInMill

When the API probe capture finished.

Long

 

captureStatusapicApiName

The capture statustransaction API name.

String

  • ACTIVE

  • STOPPING

  • COMPLETED

  • ABORTED

Example:

Code Block

apicCatalogName

The transaction API catalog name.

String

clientIp

The transaction client IP address.

String

apicClientId

The transaction client ID.

String

apicFullUri

The transaction full URI path.

String

captureStatus

The API probe capture status.

String

  • ACTIVE

  • STOPPING

  • COMPLETED

  • ABORTED

Example:

Code Block
{
    "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"
    }
}

Status
colourYellow
titlePOST
Add API

...

Probe

...

Captures

The id of the record in the Database
Expand
title/op/api/v2/apiProbeCaptures/

Description:

This API addsl adds API -C probe captures.

Required Roles:

  • There shouldn’t be defined a is no custom role that denies access to “Manage API Probe“ and there is a .

  • And one of the following:

    • A custom role that

    permits access or a built-in role OpDashAdminRole

    • allows access to “Manage API Probe“.

    • The OpDashAdminRole builtin role.

URI:

/op/api/v2/apiProbeCaptures/

Request:

The request should use the

Status
colourYellow
titlePOST
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

  • eq

domainNames

Required

The domain names on which to create a probe capture.

Array of Strings

Supports wildcards

domainNamesOperator

Required

The domain names operator.

String

  • eq

durationInMinutes

Required

the 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 APIm-Debug: true header.

Boolean

  • false

    • true

    logLevel

    Optional

    The log level of the probe data to be captured.

    String

    • debug

    additionalFiltersParameters

    Optional

    API -C Probe Filterstransaction filters.

    Element

     

    additionalFiltersParameters.apicApiName

    Optional

    Filter transactions by the API name.

    String

     

    additionalFiltersParameters.apicCatalogName

    Optional

    Filter transactions by the client IP addressAPI catalog name.

    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:

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

    }

    Successful Response:

    The response includes the following fields in its result element:

    Name

    Description

    Type

    Available Options

    apiProbeCaptures

     The API probe captures that have been created.

    Array of Elements

     

    apiProbeCaptures[].id

    The ID of the API probe capture.

    Long

     

    apiProbeCaptures[].captureId

    The ID of the API probe capture in the DataPower gateway.

    String

     

    apiProbeCaptures[].deviceName

    The device name from which the API probe data was captured.

    String

     

    apiProbeCaptures[].domainName

    The domain name from which the API probe data was captured.

    String

     

    apiProbeCaptures[].captureCount

    The number of transactions to capture.

    Long

     

    apiProbeCaptures[].capturedTransactions

    The number of captured transactions.

    Long

     

    apiProbeCaptures[].captureIduserName

    The id for a transaction user name who created the API probe capture.

    String

     

    apiProbeCaptures[].deviceName

    The device name from which the debug API-C probe data was captured.

    StringstartTimeInMill

    When the API probe capture started.

    Long

     

    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 endTimeInMill

    When the API probe capture finished.

    Long

    apiProbeCaptures[].apicApiName

    The transaction API name.

    String

    apiProbeCaptures[].apicCatalogName

    The transaction API catalog name.

    String

    apiProbeCaptures[].clientIp

    The transaction client IP address.

    String

    apiProbeCaptures[].apicClientId

    The transaction client ID.

    String

    apiProbeCaptures[].apicFullUri

    The transaction full URI path.

    String

    apiProbeCaptures[].captureStatus

    The API probe capture status.

    String

    • ACTIVE

    • STOPPING

    • COMPLETED

    • ABORTED

    apiProbeCaptures[].resultCode

    The REST API probe capture creation result code.

    String

    • SUCCESS

    • WARNING

    • ERROR

    apiProbeCaptures[].resultMessage

    The REST API probe capture creation result message.

    String

     

    Example:

    Code Block
    {
    "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"
            }
        ]
    }
}

    Status
    colourRed
    titleDELETE
    Delete an API

    ...

    Probe Capture

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

    Description:

    This API deletes marks a specific API -C probe captureprobe capture for deletion (with a status of STOPPING).
    A background process will delete the API probe capture from the DataPower gateway and will change its status to STOPPED once it is deleted.

    Required Roles:

    • There shouldn’t be defined a is no custom role that denies access to “Manage API Probe“ and there is a .

    • And one of the following:

      • A custom role that

      permits access or a built-in role OpDashAdminRole

      • allows access to “Manage API Probe“.

      • The OpDashAdminRole builtin role.

    URI:

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

    Request:

    The request should use the

    Status
    colourRed
    titleDELETE
    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)ElementID.

    Long

     

    Successful Response:

    Example:

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

    ...