> For the complete documentation index, see [llms.txt](https://docs.coherence.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.coherence.io/2.4/hosting/self-hosting/open-api-reference/shutdown.md).

# Shutdown

Scheduled shutdown notices

## Records a scheduled shutdown time and announces it to connected clients.

> Sends the scheduled shutdown time to connected clients as an out-of-band message.\
> Clients connecting after the call receive it on connection.\
> \
> The server keeps running; use \`/dev/stop\` to stop the process.

```json
{"openapi":"3.0.4","info":{"title":"Replication Server REST API","version":"v8.0.0"},"tags":[{"name":"shutdown","description":"Scheduled shutdown notices"}],"servers":[{"url":"http://127.0.0.1:64001","description":"Local Rooms Replication Server"},{"url":"http://127.0.0.1:32004","description":"Local World Replication Server"}],"security":[{"rs_auth":[]}],"components":{"securitySchemes":{"rs_auth":{"type":"http","scheme":"bearer"}},"schemas":{"shutdown.NoticeRequest":{"type":"object","properties":{"shutdown_at":{"description":"Scheduled shutdown time, as a Unix timestamp in seconds (UTC).","type":"integer","format":"int64","minimum":1},"reason":{"description":"Optional human readable reason for the shutdown, delivered to clients along with\nthe notice. At most 512 bytes when UTF-8 encoded.","type":"string","maxLength":512},"payload":{"description":"Optional custom data delivered to clients along with the notice, base64 encoded.\nAt most 512 bytes once decoded.","type":"string","format":"byte"}},"required":["shutdown_at"]},"Error":{"type":"object","properties":{"error_code":{"description":"Error code indicating the type of error that occurred.","type":"string","enum":["ERR_BAD_REQUEST","ERR_INTERNAL_ERROR","ERR_RESTRICTED_MODE_CAP_REACHED","ERR_ROOMS_LIMIT_REACHED","ERR_INVALID_SCHEMA","ERR_INVALID_ROOM_LIMIT","ERR_INVALID_MAX_ENTITIES","ERR_ROOM_NOT_FOUND","ERR_HIGH_MEMORY_PRESSURE"]},"user_message":{"description":"User-friendly error message.","type":"string"}},"required":["error_code","user_message"]}}},"paths":{"/shutdown-notice":{"post":{"tags":["shutdown"],"summary":"Records a scheduled shutdown time and announces it to connected clients.","description":"Sends the scheduled shutdown time to connected clients as an out-of-band message.\nClients connecting after the call receive it on connection.\n\nThe server keeps running; use `/dev/stop` to stop the process.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/shutdown.NoticeRequest"}}},"required":true},"responses":{"200":{"description":"Shutdown notice was recorded and announced"},"400":{"description":"Bad request; invalid or missing parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Replication Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```