Skip to main content
Infrastructure/Lifecycle Upgrade

ListPrecheckItems

List current upgrade Precheck items

GET/api/v1/lifecycle/upgrades/plans/{planUuid}/precheck/items

Operation ID

ListPrecheckItems

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • planUuid
    StringRequired

    Unique UUID of the plan

Query Parameters

  • checkResult
    String

    Precheck result used to filter the results

  • riskKey
    String

    Risk key used to identify a precheck risk

  • confirmationRequired
    Boolean

    Whether to return items that require confirmation

    Example: true

  • precheckRevision
    Integer

    Precheck revision used to filter the results

    Example: 0

  • componentUuid
    String

    Component UUID used to filter the results

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • uuid
      String

      Unique identifier of this resource

      Example: value

    • taskUuid
      String

      Task uuid for this resource

      Example: value

    • orderIndex
      Integer

      Order index for this resource

      Example: 10

    • action
      String

      Action for this resource

      Example: value

    • executionKind
      String

      Execution kind for this resource

      Example: value

    • targetLevel
      String

      Target level for this resource

      Example: value

    • required
      Boolean

      Required for this resource

      Example: true

    • componentUuid
      String

      Component uuid for this resource

      Example: value

    • componentName
      String

      Component name for this resource

      Example: value

    • componentInstanceUuid
      String

      Component instance uuid for this resource

      Example: value

    • serviceInstanceUuid
      String

      Service instance uuid for this resource

      Example: value

    • nodeUuid
      String

      Node uuid for this resource

      Example: value

    • lcaUuid
      String

      Lca uuid for this resource

      Example: value

    • fromVersion
      String

      From version for this resource

      Example: value

    • fromRelease
      String

      From release for this resource

      Example: value

    • toVersion
      String

      To version for this resource

      Example: value

    • toRelease
      String

      To release for this resource

      Example: value

    • depotArtifactId
      Integer

      Depot artifact id for this resource

      Example: 10

    • localDownloadId
      Integer

      Local download id for this resource

      Example: 10

    • artifactDigest
      String

      Artifact digest for this resource

      Example: value

    • artifactManifestChecksum
      String

      Artifact manifest checksum for this resource

      Example: value

    • currentLifecycleTaskUuid
      String

      Current lifecycle task uuid for this resource

      Example: value

    • attemptCount
      Integer

      Attempt count for this resource

      Example: 10

    • status
      String

      Status for this resource

      Example: value

    • precheckRevision
      Integer

      Precheck revision for this resource

      Example: 10

    • checkKey
      String

      Check key for this resource

      Example: value

    • riskKey
      String

      Risk key for this resource

      Example: value

    • checkResult
      String

      Check result for this resource

      Example: value

    • confirmationRequired
      Boolean

      Confirmation required for this resource

      Example: true

    • fixHint
      String

      Fix hint for this resource

      Example: value

    • details
      Object

      Detailed information entries

      Example: (nested object)

    • checkedAt
      String

      Checked at for this resource

      Example: 2026-01-15T08:00:00Z

    • observedVersion
      String

      Observed version for this resource

      Example: value

    • observedRelease
      String

      Observed release for this resource

      Example: value

    • nextAction
      String

      Next action for this resource

      Example: value

    • message
      String

      Message for this resource

      Example: value

    • lastErrorCode
      String

      Last error code for this resource

      Example: value

    • lastErrorMessage
      String

      Last error message for this resource

      Example: value

    • startedAt
      String

      Started at for this resource

      Example: 2026-01-15T08:00:00Z

    • completedAt
      String

      Completed at for this resource

      Example: 2026-01-15T08:00:00Z

    • createdAt
      String

      Created at for this resource

      Example: 2026-01-15T08:00:00Z

    • updatedAt
      String

      Updated at for this resource

      Example: 2026-01-15T08:00:00Z

  • total
    String

    Total for this resource

    Example: 10

  • limit
    Integer

    Limit for this resource

    Example: 10

  • offset
    Integer

    Offset for this resource

    Example: 10

  • planUuid
    String

    Plan uuid for this resource

    Example: value

  • precheckRevision
    Integer

    Precheck revision for this resource

    Example: 10

  • precheckStatus
    String

    Precheck status for this resource

    Example: value