1. Docs
2. Reference
3. REST API Docs
4. Schema
5. DriftRun

DriftRun represents a drift detection run, including whether drift was detected and any associated updates.

Properties

• id string required
  The unique identifier of the drift run.
• driftDetected boolean required
  Whether drift was detected during the run.
• created string required
  The timestamp when the drift run was created.
• status enum required
  The current status of the drift run. For a run started by a deployment, this is the deployment’s status. Otherwise it is derived from the state of the run’s refresh preview update: running while the update is in progress, then succeeded or failed. Canceled and timed-out updates report failed.
  Values:

  not-started — NotStarted

  The work has been created but has not started yet.

  accepted — Accepted

  The work has been picked up for execution but has not started running yet.

  running — Running

  The work is executing.

  failed — Failed

  The work finished without completing successfully. Failures, timeouts, and cancellations are all reported as failed, and there is no separate status for canceled work. This is a terminal status.

  succeeded — Succeeded

  The work completed successfully. This is a terminal status.

  skipped — Skipped

  The work was dropped without ever running. Only deployments report this status. This is a terminal status.

• deploymentId string optional
  The deployment identifier associated with the drift run.
• deploymentVersion integer optional
  The deployment version associated with the drift run.
• detectUpdate DriftRunUpdate optional
  The update that performed drift detection.
• ↳ updateId string required
  The unique identifier of the update.
• ↳ resourceChanges map[string]integer optional
  A map of operation types to the count of resources affected.
• ↳ modified string required
  The timestamp when the update was last modified.
• ↳ status enum required
  The current status of the update, derived from its update state: running while the update is in progress, then succeeded or failed. Canceled and timed-out updates report failed.
  Values:

  not-started — NotStarted

  The work has been created but has not started yet.

  accepted — Accepted

  The work has been picked up for execution but has not started running yet.

  running — Running

  The work is executing.

  failed — Failed

  The work finished without completing successfully. Failures, timeouts, and cancellations are all reported as failed, and there is no separate status for canceled work. This is a terminal status.

  succeeded — Succeeded

  The work completed successfully. This is a terminal status.

  skipped — Skipped

  The work was dropped without ever running. Only deployments report this status. This is a terminal status.

• remediateUpdate DriftRunUpdate optional
  The update that performed drift remediation.
• ↳ updateId string required
  The unique identifier of the update.
• ↳ resourceChanges map[string]integer optional
  A map of operation types to the count of resources affected.
• ↳ modified string required
  The timestamp when the update was last modified.
• ↳ status enum required
  The current status of the update, derived from its update state: running while the update is in progress, then succeeded or failed. Canceled and timed-out updates report failed.
  Values:

  not-started — NotStarted

  The work has been created but has not started yet.

  accepted — Accepted

  The work has been picked up for execution but has not started running yet.

  running — Running

  The work is executing.

  failed — Failed

  The work finished without completing successfully. Failures, timeouts, and cancellations are all reported as failed, and there is no separate status for canceled work. This is a terminal status.

  succeeded — Succeeded

  The work completed successfully. This is a terminal status.

  skipped — Skipped

  The work was dropped without ever running. Only deployments report this status. This is a terminal status.