Apps & Surfaces
Surfaces
Explore the data types and operations available in Surfaces.
103 operations
Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
iacValidateQueryValidate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
importPortalPartSourceQueryRead a `.portal` page or component file into the model's shape without saving anything. Returns `valid`; `identified`, true when the file names its part (`<page route>`, `<component name>`) and false for bare blocks, whose route or name the caller supplies; `part`, the `portal_page` or `portal_component` model object, or null when the file cannot be read; and `diagnostics`, each with its model `path`, `message`, `severity` and `sourceRange` in the file.
invokeWorkspaceActionMutationRuns a declared Lua action as the caller on the current published Workspace version; returns JSON.
journeyViewQueryOne published journey by handle, as journeyViews would list it; null when unknown, unpublished or not visible to the caller.
journeyViewsQueryThe published journeys the caller may run or list, for menus and runners. Visible items are those the caller may read as a resource, plus their own PERSONAL items with no permission grant. The caller's own PERSONAL journeys are listed even when their required domains are out of reach, with access.usable false and no definition.
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.
listJourneysQueryList the caller's visible journey library (own personal + their teams' + instance).
listJourneyVersionsQueryList all versions of a journey, newest first (authoring history), if the caller may see it.
listMagicQueriesQueryLists every available Magic Query noun with a short description and its options — the discovery entry point.
listPortalAPICredentialsQueryList the API credentials issued for a Portal in stable identifier order, without their secrets.
listPortalDomainsQueryList the custom domain aliases reserved for a Portal, with their last known status.
listPortalLoginTicketsQueryList the login tickets issued for a Portal in stable identifier order, without their secrets.
listPortalMembershipsQueryList the memberships of a Portal in stable identifier order.
listPortalsQueryList this tenant's Portals in creation order.
listPortalSitesQueryList the sites of a Portal in creation order.
listPortalSiteVersionsQueryList the source snapshots of a site in creation order.
listPortalUsersQueryList this tenant's PortalUsers in stable identifier order.
listWorkspacesQueryList the caller's visible workspace library (own personal + their teams' + instance).
listWorkspaceVersionsQueryList all versions of a workspace, newest first (authoring history), if the caller may see it.
loadWorkspaceDataQueryRuns a declared read-only Lua loader on the current published Workspace version; returns JSON.
magicQueryQueryExecutes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.
pingQueryHealth check endpoint
portalComponentLibraryQueryThe bundled component library: its version and every component with its `.portal` text and model object.
previewPortalSiteQueryRender one page of a site snapshot to HTML for authoring preview. Business-data access is denied while previewing.
publishJourneyMutationPromote a named draft version of a journey to the live published version. Other open drafts are left untouched. Owner for PERSONAL, else journey:write.
publishPortalSiteMutationMake a snapshot the site's served version and increment the site revision. Publishing an older snapshot rolls back.
publishWorkspaceMutationPromote a named draft version of a workspace to the live published version. Other open drafts are left untouched. Owner for PERSONAL, else workspace:write.
refreshPortalDomainMutationRead a custom alias's current status from Control and update the locally cached status. Changes no Portal configuration.
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
reservePortalDomainMutationReserve a custom hostname for a Portal. Returns an expiring exclusive DNS TXT proof to publish before verifying.
revokePortalAPICredentialMutationRevoke an API credential so it no longer authenticates. The record is kept for audit, not deleted.
revokePortalLoginTicketMutationRevoke an unredeemed login ticket so it can no longer start a session. The record is kept for audit, not deleted.
revokePortalMembershipMutationRevoke a membership, immediately disabling credentials that act through it. The record is kept for audit, not deleted.
revokePortalUserMutationRevoke a PortalUser, immediately disabling their sessions and credentials. The record is kept for audit, not deleted.
schemaAuthoringCatalogQueryCompiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
searchHelpQuerySearch human-facing manuals using shared semantic and text retrieval.
setPortalAudiencesMutationReplace a Portal's audience bindings, which choose the site each kind of visitor is served.
updateJourneyMutationPatch an existing journey — only provided fields are changed. Owner for PERSONAL, else journey:write.
updateJourneyFromSourceMutationApply a revision-checked Journey XML or visibility edit while preserving fields omitted by the caller.
updatePortalMutationUpdate a Portal's configuration. Omitted input fields keep their values.
updatePortalMembershipMutationUpdate a membership's roles, policy grants or activity. Changes apply to subsequent requests without reissuing credentials.
updatePortalSiteMutationUpdate a site's settings. Omitted input fields keep their values.
updatePortalUserMutationUpdate a PortalUser. Omitted input fields keep their values; deactivation stops their authentication immediately.
updateWorkspaceMutationUpdate a workspace. Only provided fields are changed. Owner for PERSONAL, else workspace:write.
updateWorkspaceSourceMutationRevision-checked Workspace authoring update using native authorization and validation.
upsertJourneyMutationCreate a journey or overwrite its open draft. PERSONAL is self-service; TEAM/INSTANCE require journey:write.
upsertWorkspaceMutationCreate a workspace or overwrite its open draft. PERSONAL is self-service; TEAM/INSTANCE require workspace:write.
validateJourneyDefinitionMutationValidate a journey definition through the full two-tier pipeline (Tier-1 SurfaceKit + Tier-2 live-schema GraphQL) WITHOUT persisting it. Returns the full diagnostic list. Requires journey:write. Returns success:false with an explanatory diagnostic when the live schema is unavailable — unlike write mutations, this mutation never silently skips Tier-2.
validateWorkspaceDefinitionMutationValidate a workspace definition through the full two-tier pipeline (Tier-1 SurfaceKit + Tier-2 live-schema GraphQL) WITHOUT persisting it. Returns the full diagnostic list. Requires workspace:write. Returns success:false with an explanatory diagnostic when the live schema is unavailable — unlike write mutations, this mutation never silently skips Tier-2.