Recent searches

in

SiteBlueprint

uuidUUIDRequired
idintegerRequired
site_namestringRequired
subpathstringNullable
stable_domainstringRequired
ssgstringNullable
last_syncedstring (date-time)Nullable

When this Site's files were last exchanged with its source. This moves only when a sync actually transferred something, so it does not change when a sync succeeds but finds nothing new, and it is also set when a Site is created by copying another Site, before it has contacted a storage provider at all. A push that committed locally and then failed to reach the provider moves it too. It is therefore not a measure of health: use last_sync_failed_at and sync_error for that.

last_sync_failed_atstring (date-time)Nullable

When this Site's most recent sync attempt failed, or null if no failure is currently recorded. CloudCannon clears it once the Site syncs successfully again. Null does not on its own mean the Site is healthy, because a Site halted by sync_error stops attempting to sync at all, so check both fields. Syncing paused by unsaved changes, and a push that raced a change on the remote, are not failures: they are not recorded here and do not clear an existing value.

last_outputstring (date-time)Nullable
last_compiledstring (date-time)Nullable
last_compressedstring (date-time)Nullable
last_internationalisedstring (date-time)Nullable
last_publishedstring (date-time)Nullable
last_cleanedstring (date-time)Nullable
storage_providerstringNullable
client_author_namestringNullable

Deprecated. Use guest_author_name instead.

client_author_emailstringNullable

Deprecated. Use guest_author_email instead.

create_sourcestringNullable
hosting_choicestring
building_lockedbooleanNullable
editing_lockedbooleanNullable
uploads_lockedboolean
browsing_lockedboolean
last_compiled_successstring (date-time)Nullable

When this Site last built successfully. Unlike last_synced, its counterpart last_compiled records every build attempt, so a Site has a failed build when the two differ.

preview_urlstringNullable
documentation_urlstringNullable
support_urlstringNullable
client_editor_routestring
active_queststringNullable
created_atstring (date-time)Nullable
updated_atstring (date-time)Nullable
modestringNullable
project_idintegerNullable
project_uuidstringNullable
pr_numberintegerNullable
pr_external_urlstringNullable
cloudcannon_config_pathstringNullable
output_storage_providerstringNullable
domain_namestringNullable
site_icon_statestring
sync_errorstringNullable

An identifier for a syncing error that has halted this Site, or null. While it is set, CloudCannon refuses to pull from the storage provider and keeps pushes local, so the two stop exchanging changes until the provider is reconnected or disconnected. Only errors that need intervention halt a Site: a sync can fail without setting this, which last_sync_failed_at records instead.

output_errorstringNullable

An identifier for an error that has halted this Site's Build Deploys, or null. While it is set, CloudCannon stops deploying build output to the output storage provider until that provider is updated or disconnected. There is no separate record of a deploy that failed without halting, so unlike syncing there is no last_output_failed_at.

has_open_editing_sessionbooleanNullable
sync_blockedbooleanNullable

Whether syncing is paused for this Site, or null when not computed. CloudCannon pauses syncing when files with unsaved changes also changed on the storage provider, and resumes once those changes are saved or discarded. A Site halted by sync_error reports false here.

storage_provider_detailsobjectNullable
output_storage_provider_dataobject
has_site_passwordboolean
has_client_passwordboolean

Deprecated. Use has_guest_password instead.

has_guest_passwordboolean
guest_author_namestringNullable
guest_author_emailstringNullable
has_main_source_damboolean
build_configurationobject
Open in a new tab