DOCS / API REFERENCE

List regions

GET /v1/regions

GETHenHouse API v1

Request

GET /v1/regions

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

Parameters

NameTypeDescription
availablebooleanOnly regions accepting new coops

Example

curl -X GET https://api.pollosoft.example/v1/regions?available=10 \
  -H "Authorization: Bearer $COOP_TOKEN"

Response

A successful call returns 200 OK with JSON like this:

{
  "data": [
    {
      "id": "us-east-1",
      "name": "Virginia Coop",
      "status": "available",
      "latency_ms": 18
    }
  ],
  "has_more": false
}

Errors

IdempotencyThis endpoint is safe to retry. Reads do not lay eggs.