---
description: Control the built-in Background Worker.
---

# Shinobu API

## 🔑Get Shinobu Status

<mark style="color:blue;">`GET`</mark> `http://lrr.tvc-16.science/api/shinobu`

Get the current status of the Worker.

{% tabs %}
{% tab title="200 " %}
```javascript
{
  "success": 1,
  "is_alive": 1,
  "operation": "shinobu_status",
  "pid": 1608
}
```
{% endtab %}
{% endtabs %}

## 🔑Stop Shinobu

<mark style="color:green;">`POST`</mark> `http://lrr.tvc-16.science/api/shinobu/stop`

Stop the Worker.

{% tabs %}
{% tab title="200 " %}
```javascript
{
  "operation": "shinobu_stop",
  "success": 1
}
```
{% endtab %}
{% endtabs %}

## 🔑Restart Shinobu

<mark style="color:green;">`POST`</mark> `http://lrr.tvc-16.science/api/shinobu/restart`

(Re)-start the Worker.

{% tabs %}
{% tab title="200 " %}
```javascript
{
  "new_pid": 1727,
  "operation": "shinobu_restart",
  "success": 1
}
```
{% endtab %}
{% endtabs %}
