CompleteDeployment is the CI completion hook that flips a queued git deployment…

CompleteDeployment is the CI completion hook that flips a queued git deployment to live (or error) once CI has synced the built site to S3.

POST /v1/projects/{slug}/deployments/{id}/complete

Projects → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/projects/{slug}/deployments/{id}/complete`
Method	`POST`
Operation	`post_projects_by_slug_deployments_by_id_complete`
Auth	`Authorization: Bearer $HANZO_API_KEY`

CompleteDeployment is the CI completion hook that flips a queued git deployment to live (or error) once CI has synced the built site to S3.

status must be live or error. On a LIVE completion the public host is claimed FIRST, so the deployment reports the URL it actually OWNS — a CI-supplied liveUrl is a hint that can refine that URL but can never assert a subdomain another tenant holds. keys is the manifest CI just uploaded, relative to the deployment prefix: cloud reconciles the prefix against it so a page deleted from the build actually stops serving. Omit keys and nothing is deleted — the prefix only grows. Reconciliation runs only on a live completion (pruning against a failed build's manifest would delete the site the last good build is still serving) and is best-effort, so a stale leftover never turns a successful deploy into a 500. A live completion is also the one billable moment on the git path; an error completion bills nothing.

Scope: a validated principal is required (403 without one). CI authenticates with an org-scoped token through the gateway, so the deployment is resolved within that principal's org and another tenant's slug or deployment id is a 404.

Request

11 fields, body application/json (required).

Field	In	Type	Required	Description
`slug`	path	string	yes	Slug is the project the deployment belongs to, from the path.
`id`	path	string	yes	ID is the queued deployment to complete, from the path.
`bytes`	body	integer	—	Bytes is their total size in bytes.
`commit`	body	string	—	Commit is the revision that was built, recorded on the deployment.
`files`	body	integer	—	Files is how many objects CI published.
`id`	body	string	—	ID is the queued deployment to complete, from the path.
`keys`	body	string[]	—	Keys is the manifest CI just uploaded, RELATIVE to the deployment prefix.
`liveUrl`	body	string	—	LiveURL is a HINT at the address the site should serve at.
`message`	body	string	—	Message is what happened, in words — on an error completion, why it failed.
`slug`	body	string	—	Slug is the project the deployment belongs to, from the path.
`status`	body	string	—	Status is how the build ended: `live` if it succeeded, `error` if it did not.

Response

Status	Body	Meaning
`200`	projectsDeployment	ok

200 body — 21 fields.

Field	In	Type	Always	Description
`bucket`	body	string	—	Bucket is the object-store bucket its files were written to.
`bytes`	body	integer	—	Bytes is their total size in bytes.
`commit`	body	string	—	Commit is the revision that was built, for a deployment that came from a repository.
`createdAt`	body	integer	—	CreatedAt is when the deployment was queued, as Unix seconds.
`files`	body	integer	—	Files is how many objects the deployment published.
`id`	body	string	—	ID identifies this one deployment attempt, and is what CI quotes back to complete it.
`liveUrl`	body	string	—	LiveURL is where this deployment serves, once it is live.
`message`	body	string	—	Message is what happened, in words — the build's own note, or on a failure why it failed.
`prefix`	body	string	—	Prefix is the key prefix within that bucket holding EXACTLY this deployment's objects — the unit an upload grant is scoped to, so a grant for one deployment…
`projectId`	body	string	—	ProjectID is the project this deployment belongs to.
`source`	body	string	—	Source is what caused the deployment — a git push, an uploaded artifact, a generated site.
`status`	body	string	—	Status is where the attempt got to — queued, live, or failed.
`updatedAt`	body	integer	—	UpdatedAt is when it last changed state, as Unix seconds — so the gap between the two is how long the build took.
`upload`	body	projectsUploadGrant	—
`upload.expiresAt`	body	integer	—	ExpiresAt is when the grant stops being accepted, as Unix seconds.
`upload.fields`	body	object	—	Fields are form values every POST must carry VERBATIM, alongside `key` and `file`.
`upload.fields.*`	body	string	—
`upload.maxBytes`	body	integer	—	MaxBytes bounds ONE object, not the upload as a whole.
`upload.prefix`	body	string	—	Prefix is the only place this grant can write: the deployment's own key prefix.
`upload.url`	body	string	—	URL is the address to POST each object to.
`version`	body	integer	—	Version counts deployments of this project from 1, so the history reads as an ordered sequence rather than by timestamp.

Failure carries the platform error shape — see Errors.

Examples

hanzo projects deployments complete <slug> <id>

import { Configuration, ProjectsApi } from 'hanzoai';

const api = new ProjectsApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postProjectsBySlugDeploymentsByIdComplete({ slug: 'slug', id: 'id', bytes: 0, commit: "<commit>" });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProjectsApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProjectsApi(client).post_projects_by_slug_deployments_by_id_complete(slug='slug', id='id', bytes=0, commit="<commit>")

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.ProjectsAPI.PostProjectsBySlugDeploymentsByIdComplete(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::apis::{configuration::Configuration, projects_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = projects_api::post_projects_by_slug_deployments_by_id_complete(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProjectsApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new ProjectsApi(client).postProjectsBySlugDeploymentsByIdComplete();

curl -X POST https://api.hanzo.ai/v1/projects/<slug>/deployments/<id>/complete \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "bytes": 0,
       "commit": "<commit>"
     }'

The door reaches projects through the projects tool, which names its 48 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_projects"
         }
       }
     }'

Projects API · All Hanzo APIs · Interactive reference

CompleteDeployment is the CI completion hook that flips a queued git deployment…

Request

Response

Examples

On this page