Reopen the setup wizard

POST

/setup/resume

const url = 'https://example.com/api/v1/setup/resume';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/setup/resume

Reopens the setup wizard after it was skipped or completed. Clears the dismissal, completion, and checklist-dismissal flags and sets the current step to the first step whose prerequisite is still unmet (connect-arr, link-database, select-profiles, else preview-sync).

Idempotent and deliberately not gated on the wizard still being in progress: it exists to restart a wizard that is no longer running, and repeated calls recompute the same step from the same entity state.

Responses

200

Wizard reopened at the first incomplete step

application/json

Reopened wizard state and the prerequisite progress used to pick the resume step

object

wizard

required

object

completed

required

Whether the wizard has been marked completed

boolean

dismissedAt

required

Timestamp the wizard was dismissed, or null if never dismissed

string format: date-time

nullable

currentStep

required

Ordered setup wizard step

string

Allowed values: welcome connect-arr link-database select-profiles preview-sync done

progress

required

Setup prerequisite progress derived from real entity state

object

hasArrInstance

required

Whether at least one Arr instance has been connected

boolean

hasDatabase

required

Whether at least one PCD database has been linked

boolean

hasProfileSelections

required

Whether at least one instance has quality profile selections synced

boolean

Example

{
  "wizard": {
    "currentStep": "welcome"
  }
}