Promote the canary and end the rollout
POST/v1/projects/:project_id/agents/:agent_id/release/promote
Makes the canary version's config the agent's live config and clears the release. The canary is pinned by version, so an edit that landed mid-rollout is not promoted in its place — it stays an unreleased draft in the version history.
When the release carries a promotion_gate, the newest completed run of the eval it names that was recorded against this agent (agent_id) and pinned to the canary version (agent_version) must read verdict: supported. A newer run revokes an older one. Otherwise the call is a 409, whose meta names that run's eval_run_id, claim, verdict and verdict_reasons when there is one, and the rollout is left running untouched. The run that cleared the gate is recorded as eval_run_id on the version that goes live.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 429
- 500
- 502
- 4XX
The agent, now serving the promoted config
The request was malformed or failed validation.
Unauthorized
Forbidden
Agent not found
Conflict — the agent has no active release (NO_ACTIVE_RELEASE), or the newest run of its promotion_gate against the canary version does not read supported (PROMOTION_GATE_UNMET)
QUOTA_EXCEEDED — a requests quota on the calling API key or its project is spent for the window; Retry-After says when it reopens
Response Headers
Seconds until the quota window admits a request again
Unexpected server error — INTERNAL_ERROR, with the raw message never forwarded
The deployment's admission service is asked about this write and did not answer — ADMISSION_UNAVAILABLE; the write did not happen
The deployment's admission service refused this write — answered under the service's own 4xx status, with its code (matching ^[A-Za-z_][A-Za-z0-9_]{0,63}$, not necessarily an ERROR_CODES key), message and meta; the write did not happen. A status this operation also declares on its own is documented there