DOCS / API REFERENCE

Create a deployment

POST /v1/deployments

POSTHenHouse API v1

Request

POST /v1/deployments

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

Parameters

NameTypeDescription
servicestringService name
envstringTarget environment
canary_percentintegerPercent of traffic for canary

Example

curl -X POST https://api.pollosoft.example/v1/deployments \
  -H "Authorization: Bearer $COOP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"service": "example-service", "env": "example-env", "canary_percent": 10}'

Response

A successful call returns 201 Created with JSON like this:

{
  "id": "dep_a032",
  "service": "web",
  "env": "production",
  "status": "rolling_out",
  "canary_percent": 10
}

Errors

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