Sites

Change who can view this site

Set access to public or password. A password is 8–128 characters. Omit password to keep the current one, which only works when the site is already protected. Turning protection on needs CORE on the owning workspace (feature_requires_core). Turning it off is always allowed. Only a site owner can change this (site_owner_required). Takes effect on the live site at once.

put/api/v1/sites/{slug}/access

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/access
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

Request body

access'public' | 'password' required
passwordstring

Required to turn protection on. 8–128 characters. Omit it to keep the current password when the site is already protected.

Response

The site's visitor access after the change.

access'public' | 'password' required

public, or password-protected.

workspacePlan'free' | 'core' required

The owning workspace's plan. free when it has no plan row.

canEnableboolean required

True when protection can be turned on: the workspace is on CORE, or this site is already protected.

Changes

No recorded changes to this operation across all 1 revision of this API.