Get addon runtime status

GET

/addons/{slug}/status

const url = 'https://shoehorn.example.com/api/v1/addons/example/status';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://shoehorn.example.com/api/v1/addons/example/status

Returns the runtime status of an installed addon.

Parameters

Path Parameters

slug

required

string

Responses

200

Addon status

application/json

object

slug

string

enabled

boolean

status

string

Allowed values: running stopped error

last_sync

string format: date-time

last_error

string

items_synced

integer

uptime_seconds

integer

Example

{
  "status": "running"
}