Skip to content
Henceforth Docs

Overview

HTTP API for the Henceforth platform: metadata, data, auth, IAM, and HFX runtime endpoints.

Henceforth API 0.1.2

Section titled “Henceforth API 0.1.2”

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/auth/login
POST
/auth/set-password
POST
/auth/challenge
POST
/auth/verify
GET
/auth/session/exchange
GET
/.well-known/jwks.json
GET
/auth/me
POST
/auth/session
POST
/iam/principals
GET
/iam/principals/{id}
DELETE
/iam/principals/{id}
PATCH
/iam/principals/{id}
GET
/iam/principals/{id}/credentials
POST
/iam/principals/{id}/credentials
POST
/iam/principals/{id}/credentials/reset
DELETE
/iam/principals/{id}/credentials/{cid}
GET
/metadata/{moduleKey}
GET
/metadata/{moduleKey}/objects
GET
/metadata/{moduleKey}/objects/{objectKey}
GET
/metadata/{moduleKey}/objects/{objectKey}/fields
GET
/metadata/{moduleKey}/objects/{objectKey}/fields/{fieldKey}
GET
/metadata/{moduleKey}/screens
GET
/metadata/{moduleKey}/screens/{screenKey}
GET
/metadata/-/modules
GET
/metadata/-/objects
GET
/metadata/-/fields
PUT
/{branchRoot}/{moduleKey}
POST
/{branchRoot}/{moduleKey}
DELETE
/{branchRoot}/{moduleKey}
PUT
/{branchRoot}/{moduleKey}/objects/{objectKey}
POST
/{branchRoot}/{moduleKey}/objects/{objectKey}
DELETE
/{branchRoot}/{moduleKey}/objects/{objectKey}
PUT
/{branchRoot}/{moduleKey}/objects/{objectKey}/fields/{fieldKey}
POST
/{branchRoot}/{moduleKey}/objects/{objectKey}/fields/{fieldKey}
DELETE
/{branchRoot}/{moduleKey}/objects/{objectKey}/fields/{fieldKey}
PUT
/{branchRoot}/{moduleKey}/screens/{screenKey}
POST
/{branchRoot}/{moduleKey}/screens/{screenKey}
DELETE
/{branchRoot}/{moduleKey}/screens/{screenKey}
POST
/data/query
POST
/data/{moduleKey}/{objectKey}
GET
/data/{moduleKey}/{objectKey}/{idOrFieldKey}
PUT
/data/{moduleKey}/{objectKey}/{idOrFieldKey}
DELETE
/data/{moduleKey}/{objectKey}/{idOrFieldKey}
PATCH
/data/{moduleKey}/{objectKey}/{idOrFieldKey}
GET
/hfx/vendor/{asset}
POST
/hfx/compile
GET
/hfx/resolve/{moduleKey}/{screenKey}
GET
/hfx/modules/{file}
GET
/health
GET
/status
POST
/plan
POST
/apply

Authentication

Section titled “Authentication”

bearerAuth

Section titled “bearerAuth”

ES256-signed JWT issued by POST /auth/login, POST /auth/verify, or the session-exchange flow. Sent as Authorization: Bearer <token>.

Security scheme type: http

Bearer format: JWT

cookieAuth

Section titled “cookieAuth”

Session JWT carried in the hf_runtime cookie (see crate::auth::cookie::RUNTIME_COOKIE_NAME), auto-attached by the browser to same-origin requests under Path=/hfx/modules. Used instead of bearerAuth where native import() cannot set an Authorization header.

Security scheme type: apiKey

Cookie parameter name: hf_runtime