Finish setup

POST

/setup/finish

const url = 'http://127.0.0.1:7700/api/setup/finish';
const options = {method: 'POST', 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 POST \
  --url http://127.0.0.1:7700/api/setup/finish \
  --header 'Authorization: Bearer <token>'

Owner only. Marks setup done, so the box’s own screen shows the home screen.

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"
  ]
}

403

The owner’s route, called by someone who is not the box’s own screen or a device paired as the owner.

application/json

object

error

required

What went wrong

string

Example

{
  "error": "only the box's own screen or the owner's paired device can do this"
}

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