Request
GET /v1/nests
Authenticate with a bearer token. Create one with POST /v1/tokens or cluck login.
Parameters
| Name | Type | Description |
|---|---|---|
coop_id | string | Filter by coop |
image | string | Filter by image |
Example
curl -X GET https://api.pollosoft.example/v1/nests?coop_id=example&image=example \
-H "Authorization: Bearer $COOP_TOKEN"
Response
A successful call returns 200 OK with JSON like this:
{
"data": [
{
"id": "nest_77b",
"image": "api:1.4",
"cpu": 2,
"state": "running"
}
],
"has_more": false
}
Errors
HEN-2001(401): Not logged inHEN-2004(403): Insufficient pecking orderHEN-5001(429): Too many pecks
IdempotencyThis endpoint is safe to retry. Reads do not lay eggs.