Spaces

Update a space

Updates the space title, serving configuration, placement, or slug. A slug rename must be sent by itself and moves the managed hostname within its apex.

patch/v1/spaces/{spaceId}

Request

  • Base URL: https://api.spacefast.com
  • URL: https://api.spacefast.com/v1/spaces/{spaceId}
  • Auth: HTTP bearer

Path parameters

spaceIdstring required

Request body

titlestring
slugstring

Renames the space and its managed hostname. The hostname keeps its apex (space.fast, or view.fast for older spaces). Send slug by itself. Previously managed hostnames keep a temporary 307 redirect that preserves path and query to the current hostname. Immutable version URLs do not change.

baseSettingsDigeststring

Optimistic-concurrency base for versioned settings (title and config): the settingsDigest read from the Space resource when the form loaded. If provided and the space's current settings digest no longer matches, the PATCH fails with 409 publish_base_changed and changes nothing.

forceboolean

With baseSettingsDigest, acknowledge a changed base and overwrite anyway. The server records the forced overwrite in the space activity feed. This is never the default.

dataLocationstring
noindexboolean

Hide the live production site from search engines. This applies only to live hostnames of claimed spaces. Preview and version hostnames are always noindex.

pinnedboolean

Pin the space to the top of its team's space list, for everyone on the team. This is presentation only: it never changes what the space serves.

Response

Response for status 200

$schemastring uri

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

Changes

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