Publish the site (async). Poll the returned task until it completes.

Starts a deployment and returns 202 with a task_id. Poll GET /tasks/{task_id} every few seconds until status is completed or failed, then read GET /projects/{id} for live_url. 409 publish_in_progress when one is already running and 409 integration_in_progress while a service is still being placed. In the sandbox or without hosting configured the publish is simulated and answers with a preview link.

POSThttps://app.softsolz.uk/api/v1/services/site-builder/projects/{id}/publish

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Response

Response Body

deployment_idintegerDeployment row id.

task_idstringPoll GET /tasks/{task_id}.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.siteBuilder.publishProject('<id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 202

{
  "data": {
    "deployment_id": 0,
    "task_id": "string"
  }
}