Restart container

POST/api/docker/{name}/restart

Restarts one container. Protection: token. Starting the container again undoes it, so no confirmation is asked.

Authorizations

Authorizationstringheaderrequired

The token you start the server with: homebutler serve --token <token>, or web.token in the config file. Send it as Authorization: Bearer <token>. When the server has a token, every /api/ route except the CORS preflight requires it, reads included.

Path parameters

namestringrequired

The container name, from List containers.

Example: web

Response

200 · application/json

The container restarted.

actionstringrequired

What was done.

Available options: restartstop

containerstringrequired

The container name.

statusstringrequired

ok.

Available options: ok

cURLcURLPythonJavaScript

curl --request POST \
  --url 'http://localhost:8080/api/docker/{name}/restart' \
  --header 'Authorization: Bearer <token>'

{
  "action": "restart",
  "container": "web",
  "status": "ok"
}