Request
POST /v1/perches/deployAuthenticate with a bearer token. Create one with POST /v1/tokens or cluck login.
Parameters
| Name | Type | Description |
|---|---|---|
regions | array | List of region IDs, or ["all"] |
egg_id | string | Artifact to deploy |
Example
curl -X POST https://api.pollosoft.example/v1/perches/deploy \
-H "Authorization: Bearer $COOP_TOKEN" \
-H "Content-Type: application/json" \
-d '{"regions": [], "egg_id": "example-egg_id"}'Response
A successful call returns 201 Created with JSON like this:
{
"id": "prc_0192",
"regions": 212,
"status": "propagating"
}Errors
HEN-2001(401): Not logged inHEN-2004(403): Insufficient pecking orderHEN-5001(429): Too many pecksHEN-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.