Update site address

POST/api/v1/update_site_address

Features

Change the ADDRESS of the site: the in .docsbook.io — its path name / subdomain. NOT the display name (update_branding custom_name), NOT a domain of their own (update_domain). Works for EVERY project, including one whose pages come from the user's own GitHub repository — the address is a Docsbook setting and no repository is renamed. Pass an empty name to clear it and fall back to the default address. Report site_url from the result verbatim.

Price — $0.00001 per call (twice what serving it costs us), charged to the workspace balance, the same as over MCP.

Also reachable by name at POST /api/v1/tools/update_site_address.

Input1

Authorizationheaderrequired

Your API key, sent as Authorization: Bearer dbk_YOUR_API_KEY.Sent from your browser straight to the API — never to Docsbook, never stored.

namestring · body

The new name, as a person would write it — 'Acme API'. It becomes acme-api.docsbook.io.

Output3

okboolean

Whether the tool itself succeeded. A tool that ran and refused — an exhausted balance, a plan restriction, a bad argument — answers 200 with ok: false: the call was made and billed, and that refusal is its answer.

resultstring

The tool's own JSON answer, already parsed — not a string to parse a second time.

duration_msinteger

Server-side wall time for the call.

Use cases

Call it when the user asks to change the site's URL or path («поменяй адрес сайта», «поменяй path name»), and when a project is still on the opaque ws-- address it was reserved with before it had a name.

Limitations

The name is slugged the way the create form slugs it ('Acme API' → acme-api); a taken or reserved name is REFUSED, never silently suffixed into a different URL.
🔴 THIS MOVES A LIVE URL — the old address stops serving the site, so only call it when the user asked for it.

Responses

200The tool ran. Read ok to see whether it succeeded.

401Missing or invalid API key.

Example input

curl -X POST 'https://docsbook.io/api/v1/update_site_address' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

Example output

{
  "ok": true,
  "result": "<result>",
  "duration_ms": 0
}

更新日 Sep 24, 2026