Trigger diagnostic bundle operations - 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

Submits a request to start or stop diagnostic bundles.

HTML

POST https://hostname/v1/integration/continuous/monitoring/projects/{projectId}/diagnostic-bundles/trigger

Start Diagnostic bundle request collects and packages logs from various on-prem components for troubleshooting and diagnostic purposes. Supports START to initiate bundle creation and STOP to cancel ongoing bundles. A 202 Accepted response indicates the request was validated and dispatched.

Process Overview

  1. For START: Validate bundle name and optional description, then dispatch start request to initiate bundling.
  2. For STOP: Dispatch stop request to cancel ongoing packaging.

Key Features

  • START action to initiate diagnostic bundle creation with optional description.
  • STOP action to cancel ongoing diagnostic bundle packaging.
  • Uniform 202 response indicating request acceptance.
  • Immediate monitoring path via Location header for tracking bundle status.

Required Permissions

replication-pipeline::operate

Request

Path parameters

Key Required Type Description
projectId Yes string

Unique identifier of the project for diagnostic bundle operations.

Request body properties

Property Required Type Description
bundleName Yes string
  • Minimum length: 1 characters
description No string  
action Yes string

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

  • START
  • STOP

Request body example

"bundleName": "My-Diagnostic-Bundle",
"description": "Bundle created for troubleshooting purposes",
"action": "START"

Response

Header keys

Key Required Type Description
Location No string URL of the diagnostic bundle status endpoint for monitoring post-trigger status.

Response examples

Example status code responses for this method are shown here.

Examples
"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/trigger",
"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/trigger",
"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/trigger",
"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/trigger",
"properties": {
  "errorCode": "DI-ADAPTER-SNP-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/trigger",
"properties": {
  "errorCode": "DI-ADAPTER-DBL-0003"
}