First-run setup state

GET

/setup

const url = 'http://127.0.0.1:7700/api/setup';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url http://127.0.0.1:7700/api/setup \
  --header 'Authorization: Bearer <token>'

Until done is true, the box’s own screen shows the setup steps. A box that already ran tasks when setup arrived is migrated and counts as done.

Authorizations

deviceToken
accessToken

Responses

200

The setup state.

application/json

object

done

required

boolean

finishedAt

string | null format: date-time

migrated

The box already ran tasks when setup arrived

boolean

steps

required

object

key

additional properties

object

string format: date-time

data

suggested

required

Array<string>

Example

{
  "suggested": [
    "welcome",
    "network",
    "safety",
    "folders",
    "apps",
    "keys",
    "updates",
    "phone"
  ]
}

GurtOS is open source under the Apache License 2.0.Source code on GitHub.