---
title: "Ensure a deployment build"
method: POST
path: "/websiteSourceCode/deployment/ensure"
tags: ["Publishing"]
---

# Ensure a deployment build

`POST /websiteSourceCode/deployment/ensure`

## Request

- Base URL: `https://api.cactal.ai/v1`
- URL: `https://api.cactal.ai/v1/websiteSourceCode/deployment/ensure`
- Auth: HTTP bearer

Returns an existing non-failed deployment for the selected version or builds one. Poll status when another request is already building it.

## Request body

- object
  - `websiteId` string, required
  - `target` 'head' | 'published', required

## Response `200`

The ensured deployment for the resolved source version.

- object
  - `websiteId` string, required: Id of the website.
  - `sourceVersion` integer, required: Source version resolved from `target`.
  - `deployment` object, required: The reused or newly built deployment.
    - `id` string, required: Unique id of the deployment.
    - `status` 'building' | 'ready' | 'failed', required: Build state of the deployment.
    - `failureMessage` string, nullable: Human-readable build failure summary. `null` unless `status` is `failed`.
    - `failureKind` 'transient' | 'permanent' | 'unknown', nullable: Failure category. `null` unless `status` is `failed`.

## Other responses

- `400`: Validation failed. The response `message` names the first invalid field.
- `401`: Missing, invalid, expired, or revoked API key.
- `403`: The authenticated principal lacks the required capability.
- `404`: The resource does not exist or is outside the principal’s access scope.
- `429`: Rate limit exceeded. Retry after the number of seconds in the `Retry-After` header.

---

[API](https://skmtc.dev/cactal/apis/cactal-api.md) · [All operations](https://skmtc.dev/cactal/apis/cactal-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cactal/apis/cactal-api/revisions/9cd0fb5eacdd?raw)