Request
POST /v1/hens/{hen_id}/restartAuthenticate with a bearer token. Create one with POST /v1/tokens or cluck login.
Parameters
| Name | Type | Description |
|---|---|---|
hen_id | string | The hen ID (path) |
graceful | boolean | Drain connections first (default true) |
Example
curl -X POST https://api.pollosoft.example/v1/hens/hen_8f2a/restart \
-H "Authorization: Bearer $COOP_TOKEN" \
-H "Content-Type: application/json" \
-d '{"graceful": true}'Response
A successful call returns 201 Created with JSON like this:
{
"id": "hen_71b0",
"status": "restarting",
"graceful": true
}Errors
HEN-2001(401): Not logged inHEN-2004(403): Insufficient pecking orderHEN-5001(429): Too many pecksHEN-3001(404): Coop not foundHEN-1002(400): Missing required field
IdempotencySend an
Idempotency-Key header to make retries safe. We will return the original result instead of laying a second egg.