Rename a site
const url = 'https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"Storefront"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "Storefront" }'Changes the display name the site is listed under on the Blotout platform. Its hostname and every other setting stay as they are.
How it works
Null or blank lists the site under its root domain again. Sending the name the site already has changes nothing.
Required permissions
domain:writeon all domains, or on the addressed domain when its id is in the route
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.
Example
7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.
Unique id (UUID) of the site, as returned by the create and list operations.
Example
3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15Unique id (UUID) of the site, as returned by the create and list operations.
Request Bodyrequired
Section titled “Request Bodyrequired”The new name.
The site’s new display name.
object
New display name, at most 80 characters. Null or blank lists the site under its root domain again.
Example
StorefrontResponses
Section titled “Responses”The renamed site.
object
A site a team serves through Qinto.
object
Server-assigned unique id of the site. Address the site with it in every other operation.
Display name of the site, as shown on the Blotout platform.
Hostname Qinto serves this site on, built from its subdomain and root domain. It is fixed at creation.
Customer domain the site belongs to.
Label Qinto serves the site from, under the root domain.
pending until the site is first deployed, then active. Deleted sites are not returned at all.
Jurisdiction the site’s data is held in, or null when unrestricted. Guaranteed for Durable Objects and object storage; other storage follows locationHint where it is supported, and is otherwise placed automatically. Fixed at creation.
Region the site’s state is placed near, or null to let Cloudflare choose. Fixed at creation.
Qinto URL the site can be served from while its own DNS is not set up, or null when it has none.
Where the site is asked to be served from: its own domain, or its Qinto development_url.
Whether the deployed worker already serves the requested deliveryMode. False on a site that has never deployed — call deploy — and false while a change to a deployed site has not reached the edge, which retries on its own.
Host the site is provisioned under. It is fixed at creation.
Example
{ "site": { "domainId": "3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15", "name": "Storefront", "domain": "shop.example.com", "rootDomain": "example.com", "subdomain": "shop", "status": "pending", "jurisdiction": "eu", "locationHint": "wnam", "developmentUrl": "shopexamplecom.acme.workers.dev", "deliveryMode": "domain", "deliveryLive": true, "hostId": "9b1c7f30-2d85-4e77-a6c1-0f3d8e6b5a24" }}invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter. invalid_body — The JSON body is unparseable or failed schema validation; details pinpoints the offending fields when the body could be parsed. invalid_site — The site details were rejected before anything was created — a malformed root domain, a reserved or malformed subdomain, an unknown jurisdiction or location, or a name that is too long. message states which.
object
Machine-readable error slug; switch on this value rather than on the HTTP status alone.
Human-readable reason for this specific failure, intended for display — do not parse it programmatically.
Field-level validation errors: a tree keyed by input property, each node carrying an errors array of human-readable messages. Render it to help the caller correct the request.
object
Example
{ "error": "invalid_params", "message": "The Cloudflare API token is invalid or expired.", "details": { "errors": [], "properties": { "teamId": { "errors": [ "Invalid UUID" ] } } }}unauthenticated — The Authorization: Bearer token is missing, malformed, or no longer valid. Generate a team API token or obtain a new OAuth access token.
object
Machine-readable error slug; switch on this value rather than on the HTTP status alone.
Example
{ "error": "unauthenticated"}forbidden — The bearer credential lacks the required permission or belongs to another team, or its user lacks the organization role a developer operation needs. Update its policies, use a credential bound to the addressed team, or ask an organization owner for the role; message states the reason when one is known.
object
Machine-readable error slug; switch on this value rather than on the HTTP status alone.
Human-readable reason for this specific failure, intended for display — do not parse it programmatically.
Example
{ "error": "forbidden", "message": "The Cloudflare API token is invalid or expired."}not_found — The addressed resource does not exist within this team; check the id and retry.
object
Machine-readable error slug; switch on this value rather than on the HTTP status alone.
Example
{ "error": "not_found"}internal — Unexpected server error. Nothing is guaranteed to have been persisted; idempotent operations are safe to retry.
object
Machine-readable error slug; switch on this value rather than on the HTTP status alone.
Example
{ "error": "internal"}