Skip to main content
Infrastructure/Lifecycle Upgrade

AbortUpgradePlan

Abort an active upgrade plan

POST/api/v1/lifecycle/upgrades/plans/{planUuid}/abort

Operation ID

AbortUpgradePlan

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

application/json

Path Parameters

  • planUuid
    StringRequired

    Unique UUID of the plan

Body Fields

  • reason
    StringRequired

    Reason for this resource

    Example: value

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • plan
    Object

    Upgrade plan returned by this operation

    • uuid
      String

      Unique identifier of this resource

      Example: value

    • name
      String

      Human-readable name of this resource

      Example: my-resource

    • status
      String

      Status for this resource

      Example: value

    • executorKind
      String

      Executor kind for this resource

      Example: value

    • planScope
      String

      Plan scope for this resource

      Example: value

    • operation
      String

      Operation for this resource

      Example: value

    • updateType
      String

      Update type for this resource

      Example: value

    • createdBy
      String

      Created by for this resource

      Example: value

    • bundleName
      String

      Bundle name for this resource

      Example: value

    • targetBundleVersionUuid
      String

      Target bundle version 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

    • precheckRevision
      Integer

      Precheck revision for this resource

      Example: 10

    • precheckStatus
      String

      Precheck status for this resource

      Example: value

    • backupRecordUuid
      String

      Backup record uuid for this resource

      Example: value

    • autoExecute
      Boolean

      Auto execute for this resource

      Example: true

    • blockedReason
      String

      Blocked reason for this resource

      Example: value

    • failureType
      String

      Failure type for this resource

      Example: value

    • currentTaskUuid
      String

      Current task uuid for this resource

      Example: value

    • currentStepUuid
      String

      Current step uuid for this resource

      Example: value

    • failedTaskUuid
      String

      Failed task uuid for this resource

      Example: value

    • failedStepUuid
      String

      Failed step uuid for this resource

      Example: value

    • failedLifecycleTaskUuid
      String

      Failed lifecycle task uuid for this resource

      Example: value

    • nextAction
      String

      Next action 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

    • backupRecord
      Object

      Backup record for this resource

      • uuid
        String

        Unique identifier of this resource

        Example: value

      • sourceType
        String

        Source type for this resource

        Example: value

      • sourceUuid
        String

        Source uuid for this resource

        Example: value

      • status
        String

        Status for this resource

        Example: value

      • artifactCount
        Integer

        Artifact count for this resource

        Example: 10

      • expiresAt
        String

        Expires at for this resource

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

      • errorCode
        String

        Error code for this resource

        Example: value

      • errorMessage
        String

        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

      • deletedAt
        String

        Deleted 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

      • backupRange
        Object

        Backup range for this resource

        Example: (nested object)

      • manifestSetChecksum
        String

        Manifest set checksum for this resource

        Example: value

      • targetMembershipChangesChecksum
        String

        Target membership changes checksum for this resource

        Example: value

      • deleteReason
        String

        Delete reason for this resource

        Example: value

      • physicalDeleteError
        String

        Physical delete error for this resource

        Example: value

      • artifacts
        List

        Artifacts for this resource

        Example: (nested array)

        • uuid
          String

          Unique identifier of this resource

          Example: value

        • backupRecordUuid
          String

          Backup record uuid for this resource

          Example: value

        • artifactName
          String

          Artifact name for this resource

          Example: value

        • componentUuid
          String

          Component uuid 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

        • path
          String

          Storage path of this artifact

          Example: value

        • digest
          String

          Digest for this resource

          Example: value

        • sizeBytes
          String

          Size bytes for this resource

          Example: 10

        • status
          String

          Status for this resource

          Example: value

        • manifestChecksum
          String

          Manifest checksum for this resource

          Example: value

        • lifecycleTaskUuid
          String

          Lifecycle task uuid for this resource

          Example: value

        • attemptIndex
          Integer

          Attempt index for this resource

          Example: 10

        • errorCode
          String

          Error code for this resource

          Example: value

        • errorMessage
          String

          Error message for this resource

          Example: value

        • physicalDeleteError
          String

          Physical delete error for this resource

          Example: value

        • 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

    • precheckSummary
      Object

      Precheck summary for this resource

      Example: (nested object)

    • tasks
      List

      Tasks for this resource

      Example: (nested array)

      • uuid
        String

        Unique identifier of this resource

        Example: value

      • planUuid
        String

        Plan uuid for this resource

        Example: value

      • batchIndex
        Integer

        Batch index for this resource

        Example: 10

      • orderIndex
        Integer

        Order index for this resource

        Example: 10

      • componentUuid
        String

        Component uuid for this resource

        Example: value

      • componentName
        String

        Component name for this resource

        Example: value

      • taskType
        String

        Task type 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

      • status
        String

        Status for this resource

        Example: value

      • skipReason
        String

        Skip reason for this resource

        Example: value

      • blockedReason
        String

        Blocked reason for this resource

        Example: value

      • failureType
        String

        Failure type for this resource

        Example: value

      • lifecycleTaskUuid
        String

        Lifecycle task uuid for this resource

        Example: value

      • message
        String

        Message for this resource

        Example: value

      • startedAt
        String

        Started 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

    • steps
      List

      Steps for this resource

      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

    • targetManifestSetChecksum
      String

      Target manifest set checksum for this resource

      Example: value

    • targetMembershipChangesChecksum
      String

      Target membership changes checksum for this resource

      Example: value

    • targetMembershipChanges
      List

      Target membership changes for this resource

      Example: (nested array)

      • action
        String

        Action for this resource

        Example: value

      • fromBundleName
        String

        From bundle name for this resource

        Example: value

      • componentName
        String

        Component name for this resource

        Example: value

      • reason
        String

        Reason for this resource

        Example: value

      • componentCategory
        String

        Component category for this resource

        Example: value

      • componentType
        String

        Component type for this resource

        Example: "lifecycle-service"

    • observeDurationNs
      String

      Observe duration ns for this resource

      Example: 10

    • nextActionApi
      String

      Next action api for this resource

      Example: value

    • nextActionReason
      String

      Next action reason for this resource

      Example: value

    • manualActionRequired
      Boolean

      Manual action required for this resource

      Example: true

  • Change Time

    AddedResponse fields manualActionRequired
    View API