Get diagnostic bundle statuses - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Retrieves the statuses of diagnostic bundles for the specified project.

HTML

GET https://hostname/v1/integration/continuous/monitoring/projects/{projectId}/diagnostic-bundles/status

Optionally filter by a specific bundle ID or bundle name using the query parameters. Only one filter can be specified at a time.

Process Overview

  1. Validate caller has `replication-pipeline::view` permission.
  2. If no filters are provided, return statuses for all bundles in the project.
  3. Provide comprehensive response with bundle details by categories (for example, agent logs, runtime engine logs).

Key Features

  • Provides comprehensive bundle information with sizes in MB.
  • Supports monitoring of ongoing or completed diagnostic processes.
  • Optional filtering by bundle ID or bundle name for targeted queries.

Required Permissions

replication-pipeline::view

Request

Path parameters

Key Required Type Description
projectId Yes string

Unique identifier of the project.

Query parameters

Key Required Type Description
bundleId No string Optional bundle ID to filter results
bundleName No string Optional bundle name to filter results

Response

Response body properties

Property Required Type Description
id No string  
bundleName No string  
status No string

This property is an enumerated string type (enum) set to one of these values:

  • UNKNOWN
  • COMPLETED
  • IN_PROGRESS
  • QUEUED
  • STOPPED
  • ERROR
createdAt No string
  • Format: date-time
sizeInMB No number  
projectId No string  
projectName No string  
agentId No string  
agentName No string  
description No string  
createdBy No string  
tenantId No string  
location No string  
processName No string  
logMetadata No object  

Response examples

Example status code responses for this method are shown here.

Examples
{
  "id": "69393e6ce4b0163b32332e00",
  "bundleName": "My-Diagnostic-Bundle",
  "status": "COMPLETED",
  "createdAt": "2025-12-10T09:33:32Z",
  "sizeInMB": "0.69",
  "projectId": "6936e484e7e2955173352fea",
  "projectName": "TestProject",
  "agentId": "6d9c65d9-fa5f-441c-a70a-87d8616534c7",
  "agentName": "Agent-1",
  "description": "Bundle created for troubleshooting purposes",
  "createdBy": "test@example.com",
  "tenantId": "tenantId-12345", 
  "location": "/var/precisely/di/jobcontroller/bundles/My-Diagnostic-Bundle.zip",
  "processName": "Task_1765359212264",
  "logMetadata": {
    "categories": {
      "name": "Agent logs",
      "sizeInMB": "5.69", 
      "status": "COMPLETED",
      "items": {
        "label": "Job controller logs",
        "sizeInMB": "0.02",
        "status": "COMPLETED"
}
      "items": {
         "label": "Gateway logs",
         "sizeInMB": "5.67",
         "status": "COMPLETED"
  }
}
    "categories": {
      "name": "Runtime engine: Engine-1",
      "sizeInMB": "5.43",
      "status": "COMPLETED",
      "server": {
        "name": "Engine-1",
        "host": "host.docker.internal",
        "port": "51702",
        "type": "OPEN",
        "useSSLA": "false",
        "useSSLE": "false"
}
     "items": {
        "label": "Kernel logs",
        "sizeInMB": "1.61",
        "status": "COMPLETED"
}
      "items": {
        "label": "Listener logs",
        "sizeInMB": "3.68",
        "status": "COMPLETED"
}
      "items": {
        "label": "Project configuration files",
        "sizeInMB": "0.14",
        "status": "COMPLETED"
       }   
     }
   }
}
 
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
"title": "Bad Request",
"status": "400",
"detail": "Validation error occurred",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/diagnostic-bundles/status",
"properties": {
  "errorCode": "DI-ADAPTER-VAL-0000"
}
 
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.2",
"title": "Unauthorized",
"status": "401",
"detail": "Authorization failed - missing or invalid credentials",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/diagnostic-bundles/status",
"properties": {
  "errorCode": "DI-ADAPTER-AUT-0001"
}
 
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.4",
"title": "Forbidden",
"status": "403",
"detail": "Authorization failed - insufficient permissions",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/diagnostic-bundles/status",
"properties": {
  "errorCode": "DI-ADAPTER-AUT-0002"
}
 
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.5",
"title": "Not Found",
"status": "404",
"detail": "Not Found - Resource does not exist",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/diagnostic-bundles/status",
"properties": {
  "errorCode": "DI-ADAPTER-DBL-0005"
}
 
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.6",
"title": "Internal Server Error",
"status": "500",
"detail": "An unexpected error occurred",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/diagnostic-bundles/status",
"properties": {
  "errorCode": "DI-ADAPTER-DBL-0006"
}