---
title: "Report Deployment Progress"
method: POST
path: "/apps/{app_id}/deployments/{deployment_id}/status"
tags: ["App Deployments"]
---

# Report Deployment Progress

`POST /apps/{app_id}/deployments/{deployment_id}/status`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/apps/{app_id}/deployments/{deployment_id}/status`
- Auth: HTTP bearer

The build controller reports progress. THE KEYSTONE (M9 item J2).

Without this, every deploy route below is inert. `POST /deployments` writes
`queued`, and the state machine allows `queued -> building -> promoting ->
deployed`. Nothing anywhere wrote `building` or `promoting`, so promote asked
for `queued -> deployed`, which is illegal, and **every real deployment that
has ever existed 409s on promote** while `deployments/active` returns null for
every builder.

AUTHENTICATED AS THE CONTROLLER, NOT THE BUILDER, and that is the whole point.
A builder's own key must not be able to walk their deployment to `promoting`
with no build having run, then promote it: the machine would read green and
the image would be whatever was there before, or nothing. So this route takes
no `user` at all. See `dependencies/build_controller_auth.py`.

`deployed` IS NOT SETTABLE HERE. The controller knows when a build finished; it
does not decide the app should take traffic. That is promote, a separate act
by the builder. Collapsing them would let whichever pod ran the build put an
app in front of users.

409 on an illegal transition rather than a silent no-op, so a controller that
reports out of order learns it rather than leaving a deployment wedged in a
state nobody wrote.

404 for an unknown deployment, and 404 for a wrong or absent controller token,
deliberately indistinguishable. The controller is not a tenant and has no org,
so there is no ownership check to make here: the deployment id is resolved
against the control plane rather than trusted, and it is the only thing this
credential can act on.

## Path parameters

- `app_id` string, required
- `deployment_id` string, required

## Headers

- `x-build-controller-token` string, nullable

## Request body

- DeploymentProgressRequest: What the in-cluster build controller reports as a build advances (J2). THE ALLOWED SET IS `building | promoting | failed`, AND `deployed` IS ABSENT ON PURPOSE. The controller knows when a build started and when an image is pushed and ready. It does not decide that the app should take traffic; that is `POST .../promote`, a separate act by the builder. Letting the callback write `deployed` would collapse "the build finished" and "send users at it" into one step performed by whichever pod happened to run the build. `rolled_back` is likewise absent: a rollback is a decision about a deployment that is already serving, which a builder makes.
  - `status` 'building' | 'promoting' | 'failed', required: Where the build has reached. `deployed` is not settable here -- taking traffic is a separate, builder-initiated promote.
  - `image_digest` string, nullable: The pushed image digest, once there is one. Reported with `promoting`.
  - `last_error_sanitized` string, nullable: A short, ALREADY-SANITIZED failure reason, surfaced to the builder. Build logs carry secrets and other tenants' identifiers, so the controller sanitizes before sending and this field is truncated here.

## Response `200`

Successful Response

- ApiResponseDeploymentResponse
  - `data` DeploymentResponse, required
    - `deployment_id` string, required
    - `app_id` string, required
    - `status` string, required
    - `source_ref` string, nullable
    - `image_digest` string, nullable
    - `schema_version_id` string, nullable
    - `last_error_sanitized` string, nullable: Sanitized at the write. Build logs carry secrets and other tenants' ids.
    - `created_at` string, date-time, nullable
    - `deployed_at` string, date-time, nullable
    - `build_started_at` string, date-time, nullable: When the build started. `null` means it was not measured.
    - `build_finished_at` string, date-time, nullable: When the build ended, at `promoting` or at `failed`. Not at `deployed`: that is reached after traffic is taken, so measuring to it would count promotion and rollout as build time.
    - `build_seconds` number, nullable: Measured build duration. `null` means NOT MEASURED, never zero: a build whose transitions were not reported has no duration, and a metering pipeline reading 0 would bill nothing and look correct.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)