Skip to content
Henceforth Docs

Overview

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

Henceforth API 0.1.3

Section titled “Henceforth API 0.1.3”

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
POST
/v1/auth/login
POST
/v1/auth/set-password
POST
/v1/auth/challenge
POST
/v1/auth/verify
GET
/v1/auth/session/exchange
POST
/v1/auth/session/redeem
GET
/v1/auth/me
POST
/v1/auth/session
GET
/.well-known/jwks.json
POST
/v1/iam/principals
GET
/v1/iam/principals/{id}
DELETE
/v1/iam/principals/{id}
PATCH
/v1/iam/principals/{id}
GET
/v1/iam/principals/{id}/credentials
POST
/v1/iam/principals/{id}/credentials
POST
/v1/iam/principals/{id}/credentials/reset
DELETE
/v1/iam/principals/{id}/credentials/{cid}
GET
/v1/metadata/{moduleKey}
GET
/v1/metadata/{moduleKey}/objects
GET
/v1/metadata/{moduleKey}/objects/{objectKey}
GET
/v1/metadata/{moduleKey}/objects/{objectKey}/fields
GET
/v1/metadata/{moduleKey}/objects/{objectKey}/fields/{fieldKey}
GET
/v1/metadata/{moduleKey}/screens
GET
/v1/metadata/{moduleKey}/screens/{screenKey}
GET
/v1/metadata/{moduleKey}/relationships
GET
/v1/metadata/-/modules
GET
/v1/metadata/-/objects
GET
/v1/metadata/-/fields
PUT
/v1/metadata@{branchId}/{moduleKey}
POST
/v1/metadata@{branchId}/{moduleKey}
DELETE
/v1/metadata@{branchId}/{moduleKey}
PUT
/v1/metadata@{branchId}/{moduleKey}/objects/{objectKey}
POST
/v1/metadata@{branchId}/{moduleKey}/objects/{objectKey}
DELETE
/v1/metadata@{branchId}/{moduleKey}/objects/{objectKey}
PUT
/v1/metadata@{branchId}/{moduleKey}/objects/{objectKey}/fields/{fieldKey}
POST
/v1/metadata@{branchId}/{moduleKey}/objects/{objectKey}/fields/{fieldKey}
DELETE
/v1/metadata@{branchId}/{moduleKey}/objects/{objectKey}/fields/{fieldKey}
PUT
/v1/metadata@{branchId}/{moduleKey}/screens/{screenKey}
POST
/v1/metadata@{branchId}/{moduleKey}/screens/{screenKey}
DELETE
/v1/metadata@{branchId}/{moduleKey}/screens/{screenKey}
POST
/v1/metadata@{branchId}/publish
GET
/v1/metadata@{branchId}/diff
GET
/v1/ontology
GET
/v1/ontology/{moduleKey}
POST
/v1/data/query
POST
/v1/data/{moduleKey}/{objectKey}
GET
/v1/data/{moduleKey}/{objectKey}/{idOrFieldKey}
PUT
/v1/data/{moduleKey}/{objectKey}/{idOrFieldKey}
DELETE
/v1/data/{moduleKey}/{objectKey}/{idOrFieldKey}
PATCH
/v1/data/{moduleKey}/{objectKey}/{idOrFieldKey}
GET
/v1/surfaces
POST
/v1/plan
POST
/v1/apply
GET
/health
GET
/ready
GET
/status
GET
/.well-known/henceforth/openapi.json
GET
/.well-known/henceforth/schema/{type}.json

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