Turn remote access off

DELETE

/remote

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

Owner only. Stops the tunnel and the certificate service, releases the name at the relay and removes the box’s relay secret from the vault. The certificate is kept for next time.

Authorizations

deviceToken
accessToken

Responses

200

The state, now off.

application/json

object

enabled

required

boolean

name

required

string | null

url

required

The box’s own https address.

string | null

state

required

string

Allowed values: off starting connected error

error

Why it failed, in words. If the relay no longer holds this box’s name (freed after 30 days offline, or given to another computer), it says to turn remote access off and on again.

string

relay

required

The relay’s host name.

string

released

Whether the relay released the name. If not

boolean

Example

{
  "state": "off"
}

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