Apps & Surfaces

Surfaces

Explore the data types and operations available in Surfaces.

103 operations

iacSchemaDocumentQuery

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

iacValidateQuery

Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.

importPortalPartSourceQuery

Read 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.

invokeWorkspaceActionMutation

Runs a declared Lua action as the caller on the current published Workspace version; returns JSON.

journeyViewQuery

One published journey by handle, as journeyViews would list it; null when unknown, unpublished or not visible to the caller.

journeyViewsQuery

The 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.

listDataChangeEventTopicsQuery

List all valid data change event topics, grouped by resource. Requires authentication.

listJourneysQuery

List the caller's visible journey library (own personal + their teams' + instance).

listJourneyVersionsQuery

List all versions of a journey, newest first (authoring history), if the caller may see it.

listMagicQueriesQuery

Lists every available Magic Query noun with a short description and its options — the discovery entry point.

listPortalAPICredentialsQuery

List the API credentials issued for a Portal in stable identifier order, without their secrets.

listPortalDomainsQuery

List the custom domain aliases reserved for a Portal, with their last known status.

listPortalLoginTicketsQuery

List the login tickets issued for a Portal in stable identifier order, without their secrets.

listPortalMembershipsQuery

List the memberships of a Portal in stable identifier order.

listPortalsQuery

List this tenant's Portals in creation order.

listPortalSitesQuery

List the sites of a Portal in creation order.

listPortalSiteVersionsQuery

List the source snapshots of a site in creation order.

listPortalUsersQuery

List this tenant's PortalUsers in stable identifier order.

listWorkspacesQuery

List the caller's visible workspace library (own personal + their teams' + instance).

listWorkspaceVersionsQuery

List all versions of a workspace, newest first (authoring history), if the caller may see it.

loadWorkspaceDataQuery

Runs a declared read-only Lua loader on the current published Workspace version; returns JSON.

magicQueryQuery

Executes 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.

pingQuery

Health check endpoint

portalComponentLibraryQuery

The bundled component library: its version and every component with its `.portal` text and model object.

previewPortalSiteQuery

Render one page of a site snapshot to HTML for authoring preview. Business-data access is denied while previewing.

publishJourneyMutation

Promote a named draft version of a journey to the live published version. Other open drafts are left untouched. Owner for PERSONAL, else journey:write.

publishPortalSiteMutation

Make a snapshot the site's served version and increment the site revision. Publishing an older snapshot rolls back.

publishWorkspaceMutation

Promote a named draft version of a workspace to the live published version. Other open drafts are left untouched. Owner for PERSONAL, else workspace:write.

refreshPortalDomainMutation

Read a custom alias's current status from Control and update the locally cached status. Changes no Portal configuration.

renderSchemaXMLQuery

Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.

reservePortalDomainMutation

Reserve a custom hostname for a Portal. Returns an expiring exclusive DNS TXT proof to publish before verifying.

revokePortalAPICredentialMutation

Revoke an API credential so it no longer authenticates. The record is kept for audit, not deleted.

revokePortalLoginTicketMutation

Revoke an unredeemed login ticket so it can no longer start a session. The record is kept for audit, not deleted.

revokePortalMembershipMutation

Revoke a membership, immediately disabling credentials that act through it. The record is kept for audit, not deleted.

revokePortalUserMutation

Revoke a PortalUser, immediately disabling their sessions and credentials. The record is kept for audit, not deleted.

schemaAuthoringCatalogQuery

Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.

searchHelpQuery

Search human-facing manuals using shared semantic and text retrieval.

setPortalAudiencesMutation

Replace a Portal's audience bindings, which choose the site each kind of visitor is served.

updateJourneyMutation

Patch an existing journey — only provided fields are changed. Owner for PERSONAL, else journey:write.

updateJourneyFromSourceMutation

Apply a revision-checked Journey XML or visibility edit while preserving fields omitted by the caller.

updatePortalMutation

Update a Portal's configuration. Omitted input fields keep their values.

updatePortalMembershipMutation

Update a membership's roles, policy grants or activity. Changes apply to subsequent requests without reissuing credentials.

updatePortalSiteMutation

Update a site's settings. Omitted input fields keep their values.

updatePortalUserMutation

Update a PortalUser. Omitted input fields keep their values; deactivation stops their authentication immediately.

updateWorkspaceMutation

Update a workspace. Only provided fields are changed. Owner for PERSONAL, else workspace:write.

updateWorkspaceSourceMutation

Revision-checked Workspace authoring update using native authorization and validation.

upsertJourneyMutation

Create a journey or overwrite its open draft. PERSONAL is self-service; TEAM/INSTANCE require journey:write.

upsertWorkspaceMutation

Create a workspace or overwrite its open draft. PERSONAL is self-service; TEAM/INSTANCE require workspace:write.

validateJourneyDefinitionMutation

Validate 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.

validateWorkspaceDefinitionMutation

Validate 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.