Skip to content
Henceforth Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Get Started
Get Started
Concepts
Concepts
Objects, Records, and Fields
Relationships and Lookups
From Metadata to Database
Querying Data with HOQS
How-to Guides
How-to Guides
Create records through the API
Read, update, and delete records through the API
Upsert records through the API
Query and filter records
Include child records in queries
Aggregate query results
Reference
Reference
Metadata File Layout
Metadata
FieldDefinition
ModuleManifest
ObjectDefinition
RelationshipDefinition
ScreenDefinition
SeedDefinition
Settings
ValidationRule
Formula Language
HOQS Query Language
Diagnostics
HFX Language
HTTP API
Overview
auth
Overview
Authenticate with username/password and receive a JWT.
Consume a setup token and set a password.
Request an SSH challenge nonce.
Verify an SSH signature and receive a JWT.
Exchange a one-time code for a session JWT + cookie.
Serve the public key set for JWT verification.
Return the current principal's profile.
Generate a one-time code for browser session establishment.
iam
Overview
Create a new principal.
Get a principal by id.
Delete a principal.
Update a principal.
List credentials for a principal.
Attach a credential to a principal.
Generate a password reset token.
Revoke a credential.
metadata
Overview
Return a module's metadata record.
List the objects defined within a module.
Return an object's metadata record.
List the fields defined on an object.
Return a field's metadata record.
List the screens defined within a module.
Return a screen's metadata record.
List every module (transitional cross-module aggregation read).
List every object across all modules (transitional cross-module aggregation read).
List every field across all objects (transitional cross-module aggregation read).
Update a module (fails with 404 if absent).
Create a module (fails with 409 if it already exists).
Delete a module.
Update an object (fails with 404 if absent).
Create an object within a module (fails with 409 if it already exists).
Delete an object.
Update a field (fails with 404 if absent).
Create a field on an object (fails with 409 if it already exists).
Delete a field.
Update a screen (fails with 404 if absent).
Create a screen within a module (fails with 409 if it already exists).
Delete a screen.
data
Overview
Execute a HOQS query.
Create a new record.
Read a single record by id.
Upsert a record by a unique field.
Delete a record.
Update an existing record.
hfx
Overview
Serve a vendored React/UI static asset.
Compile HFX source to a JS ES module inline.
Resolve a screen to its immutable, commit-addressed module URL.
Serve the compiled JS for a screen module.
system
Overview
Liveness probe.
Readiness probe with database introspection.
Compute a dry-run diff between metadata and the live database.
Diff metadata against the live database and execute DDL.
For Salesforce Practitioners
For Salesforce Practitioners
Rollups
Sharing vs. RLS
GitHub
Select theme
Dark
Light
Auto
HFX Language
Reserved — lands after HFX grammar stabilizes.