🔍 Observability

Stop (and restart) the server

If you're using docker, after calling this endpoint Docker will start a new container, so you can use this endpoint to restart the server

post/api/server/stop

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/server/stop
  • Auth: API key in header X-Api-Key

Request body

forceboolean

By default, it gracefully stops the server, but you can force it to terminate immediately.

Response

stoppingboolean required

Always 'true' if the server is stopping.

Example response

{
  "stopping": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.