Get setup wizard state

GET

/setup/state

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

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

curl --request GET \
  --url https://example.com/api/v1/setup/state

Returns the current wizard step, completion/dismissal status, prerequisite progress, and default database auto-link info used to render and resume the setup wizard.

Responses

200

Setup state

application/json

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

prerequisites

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

defaultDatabase

required

Default database auto-link info used to render the link-database step

object

configured

required

Whether PRAXRR_DEFAULT_DB_URL resolves to a non-empty value

boolean

url

required

Resolved default database URL, or null when not configured

string

nullable

alreadyLinked

required

Whether any PCD database is already linked

boolean

Example

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

403

Setup has already been completed or dismissed