Remote access state

GET

/remote

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

Whether the box has its own https address through a relay, and whether the tunnel is up. The box checks the address again at most every 30 seconds, so a dropped tunnel shows. A hosted relay is not running during the preview. Point the box at a relay you run with PUT /remote/relay or BOX_RELAY.

Authorizations

deviceToken
accessToken

Responses

200

The state.

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

Example

{
  "enabled": true,
  "name": "rosa",
  "url": "https://rosa.box.example.com",
  "state": "connected",
  "relay": "box.example.com"
}