Add a custom domain and get the DNS records to create.

Only after the first publish. Give the person the dns_records to add at their registrar, then call verify. 400 domains_unavailable in the sandbox.

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

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.

Body Params

domainstring

Hostname such as www.example.com or example.com.

Response

Response Body

idintegerDomain id.

domainstringHostname.

statusstringpending until DNS is verified.

dns_recordsarray of objectsRecords to create at the registrar: { type, name, value }.

last_checked_atstring | nullLast verification attempt.

verified_atstring | nullWhen DNS verified.

created_atstringAdded at.

Request

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

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

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

Credentials

Authorization

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

Response · 201

{
  "data": {
    "id": 0,
    "domain": "string",
    "status": "string",
    "dns_records": [],
    "last_checked_at": "string",
    "verified_at": "string",
    "created_at": "string"
  }
}