Skip to content

Custom subdomains

import { Aside } from ‘@astrojs/starlight/components’;

Teams workspaces can serve artifacts at {workspace}.shareout.site — a branded home that keeps all workspace URLs under one host.

URLServes
{workspace}.shareout.site/Workspace landing / gallery.
{workspace}.shareout.site/{artifact-slug}Artifact in the workspace.
{workspace}.shareout.site/{folder}/{artifact-slug}Artifact inside a folder.

Workspace artifacts are also reachable at shareout.site/@{workspace}/{artifact}.

A subdomain is not just a public gallery — it is a full mirror of the apex app for that workspace. These paths pass through unchanged so members can sign in, open Home, edit artifacts, and call APIs from the branded host:

/v1/, /auth/, /sdk/, /embed/, /t/, /a/, /p/, /@, /brand/, /wl/, /settings/, /app/, /home, /create

That means {workspace}.shareout.site/app/… serves the same Home and studio surfaces as shareout.site/app/…, scoped to the workspace context. Use relative links inside artifacts and product UI so pages work on both hosts.

Requires Teams plan and workspace admin or owner.

POST /v1/workspaces/{workspaceId}/subdomain
Authorization: Bearer {token}
Content-Type: application/json
{ "enabled": true }
{
"success": true,
"subdomain": "acme.shareout.site",
"workspace_slug": "acme",
"enabled": true
}
DELETE /v1/workspaces/{workspaceId}/subdomain
Authorization: Bearer {token}
GET /v1/workspaces/{workspaceId}/subdomain
Authorization: Bearer {token}

These workspace slugs are reserved and cannot be used as subdomain names: www, api, app, admin, cdn, static, mail, assets, support, help, status.

Use relative links inside artifact HTML when the artifact should work on both the subdomain URL and the canonical shareout.site/@{workspace}/… URL. Do not hardcode the subdomain hostname.