Skip to content

Turn an app off

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

Owner only. Takes the app’s tools, jobs, routes, webhooks, log readers and windows out at once and stops its triggers. A task that asks for one of its tools is refused. A trigger that cannot be stopped keeps running until the box restarts, and the app reports restartNeeded: true.

id
required
string

The app’s id, its folder name.

Example

wallet

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

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

No app with this id.

Media typeapplication/json
object
error
required

What went wrong

string

Example generated

{
"error": "example"
}

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