DEdepot
CIService

Returns a failure diagnosis for a run, workflow, job, or attempt.

For run and workflow targets, identical failures are grouped together by error fingerprint. For job and attempt targets, the response is a focused diagnosis of that single job or attempt. When too many jobs failed to diagnose individually, the response is a per-workflow and per-job breakdown instead. When no failure evidence is found, the response is empty. The response is limited to a fixed size and reflects the run's current state. The diagnosis can change while a run is in progress. As more jobs fail, a later call can surface new failures or turn an empty result into a grouped one. As job summaries become available, a later call can also add summary drill-down commands.

post/depot.ci.v1.CIService/GetFailureDiagnosis

Request

  • Base URL
    https://api.depot.dev
  • Auth
    HTTP bearer

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

targetIdstring required

Unique identifier for the resource to diagnose: a CI run, workflow, job, or attempt. Must match targetType.

targetType'FAILURE_DIAGNOSIS_TARGET_TYPE_UNSPECIFIED' | 'FAILURE_DIAGNOSIS_TARGET_TYPE_RUN' | 'FAILURE_DIAGNOSIS_TARGET_TYPE_WORKFLOW' | 'FAILURE_DIAGNOSIS_TARGET_TYPE_JOB' | 'FAILURE_DIAGNOSIS_TARGET_TYPE_ATTEMPT' required

Resource kind a failure diagnosis can target.

Response

Success

orgIdstring

Depot organization that owns the diagnosed resource.

state'FAILURE_DIAGNOSIS_STATE_UNSPECIFIED' | 'FAILURE_DIAGNOSIS_STATE_EMPTY' | 'FAILURE_DIAGNOSIS_STATE_GROUPED_FAILURES' | 'FAILURE_DIAGNOSIS_STATE_FOCUSED_FAILURE' | 'FAILURE_DIAGNOSIS_STATE_OVER_LIMIT'

Overall shape of the failure diagnosis response.

  • EMPTY: No failure evidence found. failureGroups and representativeAttempts are empty.
  • GROUPED_FAILURES: Failures grouped by fingerprint into failureGroups. Returned for run and workflow targets.
  • FOCUSED_FAILURE: Diagnosis focuses on a single job or attempt. Returned for job and attempt targets.
  • OVER_LIMIT: Too many failed candidates to diagnose individually. overLimitBreakdown lists per-workflow and per-job counts instead.
emptyReason'FAILURE_DIAGNOSIS_EMPTY_REASON_UNSPECIFIED' | 'FAILURE_DIAGNOSIS_EMPTY_REASON_NO_FAILURE_EVIDENCE'

Reason a diagnosis was returned in the EMPTY state.

Changes

No recorded changes to this operation across all 1 revision of this API.