---
updatedAt: 2026-08-06T14:07:07.000Z
agentTools:
  projectIndex: https://docs.noves.fi/llms.txt
---

# Get a history-repair diagnostic

Returns a bounded diagnostic report for one repair correlation after projecting affected update data to an authorized focal party.

# OpenAPI definition

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "Noves App API",
    "description": "Access Canton updates, party data, rewards, accounting data, and other Noves App features.",
    "version": "v1"
  },
  "paths": {
    "/api/v2/historyRepairs/{correlationId}/diagnostic": {
      "get": {
        "tags": [
          "Operations"
        ],
        "summary": "Get a history-repair diagnostic",
        "description": "Returns a bounded diagnostic report for one repair correlation after projecting affected update data to an authorized focal party.",
        "parameters": [
          {
            "name": "correlationId",
            "in": "path",
            "description": "History-repair correlation identifier.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "jwt",
            "in": "header",
            "description": "Ledger API JWT used to resolve party permissions or administrator access.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "jwt",
            "in": "query",
            "description": "Ledger API JWT alternative to the jwt header.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeId",
            "in": "query",
            "description": "Configured validator-node identifier. Defaults to the deployment's default node.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nodeId",
            "in": "header",
            "description": "Configured validator-node identifier; the query value takes precedence.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CantonDataApp.Data.HistoryRepairDiagnosticReport"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CantonDataApp.Api.ApiErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CantonDataApp.Api.ApiErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CantonDataApp.Api.ApiErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CantonDataApp.Api.ApiErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CantonDataApp.Api.ApiErrorResponse"
                }
              }
            }
          },
          "503": {
            "description": "Service is still starting",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/CantonDataApp.Database.StartupStatusResponse"
                    },
                    {
                      "$ref": "#/components/schemas/CantonDataApp.Api.QuarantinedNodeResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CantonDataApp.Api.ApiErrorResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Api.QuarantinedNodeResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "nullable": true
          },
          "nodeId": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "network": {
            "type": "string",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Data.HistoryRepairDiagnosticReport": {
        "type": "object",
        "properties": {
          "version": {
            "type": "integer",
            "format": "int32"
          },
          "repairJob": {
            "$ref": "#/components/schemas/CantonDataApp.Data.HistoryRepairJobDiagnostic"
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Data.HistoryRepairJobDiagnostic": {
        "type": "object",
        "properties": {
          "buildVersion": {
            "type": "string",
            "nullable": true
          },
          "schemaVersion": {
            "type": "string",
            "nullable": true
          },
          "correlationId": {
            "type": "string",
            "nullable": true
          },
          "materializationId": {
            "type": "string",
            "nullable": true
          },
          "materializationGeneration": {
            "type": "integer",
            "format": "int32"
          },
          "focalParty": {
            "type": "string",
            "nullable": true
          },
          "historyScope": {
            "type": "string",
            "nullable": true
          },
          "state": {
            "type": "string",
            "nullable": true
          },
          "attemptCount": {
            "type": "integer",
            "format": "int32"
          },
          "attemptTimeline": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CantonDataApp.Data.RepairAttemptDiagnostic"
            },
            "nullable": true
          },
          "classifiedUpdateSeq": {
            "type": "string",
            "nullable": true
          },
          "sourceFrontier": {
            "type": "string",
            "nullable": true
          },
          "modelFrontiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CantonDataApp.Data.RepairModelFrontierDiagnostic"
            },
            "nullable": true
          },
          "dirtyQueue": {
            "$ref": "#/components/schemas/CantonDataApp.Data.RepairQueueDiagnostic"
          },
          "scheduler": {
            "$ref": "#/components/schemas/CantonDataApp.Data.RepairSchedulerDiagnostic"
          },
          "failure": {
            "$ref": "#/components/schemas/CantonDataApp.Data.RepairFailureDiagnostic"
          },
          "sanitizedLogs": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "affectedTransactions": {
            "type": "array",
            "items": {},
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Data.RepairAttemptDiagnostic": {
        "type": "object",
        "properties": {
          "event": {
            "type": "string",
            "nullable": true
          },
          "attempt": {
            "type": "integer",
            "format": "int32"
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "at": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Data.RepairFailureDiagnostic": {
        "type": "object",
        "properties": {
          "stage": {
            "type": "string",
            "nullable": true
          },
          "errorCode": {
            "type": "string",
            "nullable": true
          },
          "classifierVersion": {
            "type": "string",
            "nullable": true
          },
          "affectedModels": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Data.RepairModelFrontierDiagnostic": {
        "type": "object",
        "properties": {
          "model": {
            "type": "string",
            "nullable": true
          },
          "completedClassifiedUpdateSeq": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Data.RepairQueueDiagnostic": {
        "type": "object",
        "properties": {
          "pendingCount": {
            "type": "string",
            "nullable": true
          },
          "oldestAgeSeconds": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Data.RepairSchedulerDiagnostic": {
        "type": "object",
        "properties": {
          "bootstrapThrottled": {
            "type": "boolean"
          },
          "throttleReasons": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "captureLagChanges": {
            "type": "string",
            "nullable": true
          },
          "oldestLiveDirtyAgeSeconds": {
            "type": "string",
            "nullable": true
          },
          "dirtyDeadTupleRatio": {
            "type": "number",
            "format": "double"
          },
          "snapshotXminAge": {
            "type": "string",
            "nullable": true
          },
          "processRssBytes": {
            "type": "string",
            "nullable": true
          },
          "backendContainerFreeDiskBytes": {
            "type": "string",
            "nullable": true
          },
          "databaseActiveSessionRatio": {
            "type": "number",
            "format": "double"
          },
          "writeIoUtilization": {
            "type": "number",
            "format": "double"
          },
          "connectionUtilization": {
            "type": "number",
            "format": "double"
          },
          "sourceCommitP95Milliseconds": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Database.LifecycleIndexStatusResponse": {
        "type": "object",
        "properties": {
          "nodeId": {
            "type": "string",
            "nullable": true
          },
          "definitionFingerprint": {
            "type": "string",
            "nullable": true
          },
          "ready": {
            "type": "boolean"
          },
          "cursor": {
            "type": "integer",
            "format": "int64"
          },
          "remainingSourceRows": {
            "type": "integer",
            "format": "int64"
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Database.ReplayNodeStatus": {
        "type": "object",
        "properties": {
          "nodeId": {
            "type": "string",
            "nullable": true
          },
          "currentOffset": {
            "type": "integer",
            "format": "int64"
          },
          "targetOffset": {
            "type": "integer",
            "format": "int64"
          },
          "status": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Database.StartupReplayResponse": {
        "type": "object",
        "properties": {
          "nodes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CantonDataApp.Database.ReplayNodeStatus"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CantonDataApp.Database.StartupStatusResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "nullable": true
          },
          "phase": {
            "type": "string",
            "nullable": true
          },
          "phaseNumber": {
            "type": "integer",
            "format": "int32"
          },
          "totalPhases": {
            "type": "integer",
            "format": "int32"
          },
          "startedAt": {
            "type": "string",
            "nullable": true
          },
          "elapsedSeconds": {
            "type": "integer",
            "format": "int32"
          },
          "error": {
            "type": "string",
            "nullable": true
          },
          "schemaVersion": {
            "type": "string",
            "nullable": true
          },
          "targetSchemaVersion": {
            "type": "string",
            "nullable": true
          },
          "bootstrapSource": {
            "type": "string",
            "nullable": true
          },
          "bootstrapVersion": {
            "type": "string",
            "nullable": true
          },
          "pendingMigrations": {
            "type": "integer",
            "format": "int32"
          },
          "lastMigrationDurationMs": {
            "type": "integer",
            "format": "int64",
            "nullable": true
          },
          "dataMigrations": {
            "type": "array",
            "items": {},
            "nullable": true
          },
          "replay": {
            "$ref": "#/components/schemas/CantonDataApp.Database.StartupReplayResponse"
          },
          "lifecycleIndexes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CantonDataApp.Database.LifecycleIndexStatusResponse"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    }
  },
  "tags": [
    {
      "name": "Operations",
      "description": "Inspect deployment health, indexing status, diagnostics, and repair jobs."
    }
  ]
}
```