DOCS / API REFERENCE

Run a container

POST /v1/nests

POSTHenHouse API v1

Request

POST /v1/nests

Authenticate with a bearer token. Create one with POST /v1/tokens or cluck login.

Parameters

NameTypeDescription
imagestringContainer image
cpunumberCPU cores
memory_mbintegerMemory limit

Example

curl -X POST https://api.pollosoft.example/v1/nests \
  -H "Authorization: Bearer $COOP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"image": "example-image", "cpu": 2, "memory_mb": 10}'

Response

A successful call returns 201 Created with JSON like this:

{
  "id": "nest_77c",
  "state": "starting",
  "cpu": 2,
  "memory_mb": 2048
}

Errors

IdempotencySend an Idempotency-Key header to make retries safe. We will return the original result instead of laying a second egg.