1. Home
  2. Docs
  3. API Documentation
  4. API Requests
  5. Starting & Stopping The Server

Starting & Stopping The Server

Starting the server

To start the server make a POST request to the following URL:
https://hub.api.caster.fm/private/server/start?token={PRIVATE_TOKEN}
If the request is successful an HTTP status code 200 will be returned along with the following JSON:

{
  "success": true,
  "error": null
}

If trying to start the server while its already online, an HTTP status code 406 will be returned with the following json:

{
  "success": false,
  "error": {
    "message": "Server already running",
    "uuid": ""
  }
}

Stopping the server

To start the server make a POST request to the following URL:
https://hub.api.caster.fm/private/server/stop?token={PRIVATE_TOKEN}
If the request is successful an HTTP status code 200 will be returned along with the following JSON:

{
  "success": true,
  "error": null
}

If trying to stop the server while its not online, an HTTP status code 406 will be returned with the following json:

{
  "success": false,
  "error": {
    "message": "Server is not running",
    "uuid": ""
  }
}