Turn an app on

POST

/apps/{id}/enable

curl --request POST \
  --url http://127.0.0.1:7700/api/apps/wallet/enable \
  --header 'Authorization: Bearer <token>'

• On the box itself (the default listen address)
• From another device, with a paired device token, when BOX_LISTEN allows it

Owner only. Loads the app’s tools, jobs, routes, log readers and windows and starts its triggers, with no reinstall. The choice is saved in BOX_HOME/apps.json.

Authorizations

• deviceToken
• accessToken

Parameters

Path Parameters

id

required

string

The app’s id, its folder name.

Example

wallet

Responses

200

The app.

Media typeapplication/json

object

name

The window’s name

string

href

The window’s path under /t/<track>/, in the default list.

string

track

The app that added it.

string

id

required

The app’s id

string

title

required

string

description

The app’s own, else the first paragraph of its README.

string

status

required

string

Allowed values: enabled disabled error

enabled

boolean

error

Why the app failed to load.

string

restartNeeded

Turned off while a trigger that cannot be stopped was running.

boolean

access

required

What the app can reach. Key names only, never values.

object

tools

Array<object>

object

name

string

description

string

jobs

Array<string>

hosts

Hosts the app’s tools reach.

Array<string>

secrets

Array<object>

object

name

string

set

Whether the vault holds this key.

boolean

triggers

Array<string>

routes

Array<string>

ui

required

The app’s windows.

Array<object>

object

name

string

title

string

href

string

Example

{
  "status": "enabled"
}

403

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

Media typeapplication/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"
}

404

No app with this id.

Media typeapplication/json

object

error

required

What went wrong

string

Example ^generated

{
  "error": "example"
}