Close the setup port

POST

/setup/stop

const url = 'http://127.0.0.1:7700/api/setup/stop';
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/stop \
  --header 'Authorization: Bearer <token>'

Owner only. Closes the setup port and revokes every setup token. Does nothing if the port is closed.

Authorizations

deviceToken
accessToken

Responses

200

The setup port, now closed.

application/json

The setup port for setting up from another computer.

object

open

required

boolean

until

When the port closes by itself.

string format: date-time

port

integer

urls

The addresses another computer can use.

Array<string>

remote

The box’s remote access address

string

devices

Array<object>

object

name

string

since

string format: date-time

Example

{
  "open": false
}

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 this computer's own screen or the owner's paired device can do this"
}