OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked

API reference · REST

Every shipped HTTP operation

Overview

An endpoint is one callable HTTP operation. Use this index to find the operation that reads data, changes the model, manages access, or supports another application workflow.

It contains 142 operations across 14 resource areas, transcribed from the executable OpenAPI contract at revision 996452a.

Quick example

The liveness endpoint is the smallest request in the API. It needs no credentials and returns plain text when the process can answer HTTP.

cURL

export ORDINATE_URL="http://localhost:8080"
curl --fail "$ORDINATE_URL/v1/healthz"
# ok

Reference

Search by method, path, operation ID, summary, or resource area. Every result opens the complete parameter, schema, response, and code reference.

142 of 142 operations

Administration4

Annotations8

Authentication22

GET/v1/auth/callbackComplete OIDC loginPOST/v1/auth/effectiveExplain an effective authorization decisionGET/v1/auth/grantsList authorization grantsPOST/v1/auth/grantsCreate an authorization grantDELETE/v1/auth/grants/{id}Retire an authorization grantGET/v1/auth/loginBegin OIDC authorization-code loginPOST/v1/auth/login/localSign in with local credentialsPOST/v1/auth/logoutRevoke the current sessionGET/v1/auth/methodsDiscover configured authentication methodsGET/v1/auth/principalsList principalsPOST/v1/auth/principalsCreate a local human principalGET/v1/auth/rolesList authorization rolesPOST/v1/auth/rolesCreate an authorization roleGET/v1/auth/roles/{id}Read an authorization rolePUT/v1/auth/roles/{id}Update or retire an authorization roleGET/v1/auth/service-identitiesList service identitiesPOST/v1/auth/service-identitiesCreate a service identityPOST/v1/auth/service-identities/{id}/tokensMint or rotate a service tokenPOST/v1/auth/service-identities/tokens/{token_id}/revokeRevoke a service tokenGET/v1/auth/sessionsList the caller's sessions or all sessionsDELETE/v1/auth/sessions/{id}Revoke a session as an administratorGET/v1/auth/whoamiDescribe the authenticated principal

Calculations7

Collectors and jobs3

Contract1

Displays13

Episodes13

Model45

POST/v1/model/assetsCreate an assetGET/v1/model/assets/{uuid}Read an asset projectionPATCH/v1/model/assets/{uuid}Rename, move, retire, or unretire an assetPOST/v1/model/assets/{uuid}/instantiateInstantiate a template beneath an assetGET/v1/model/assets/{uuid}/linksList links involving an assetGET/v1/model/assets/{uuid}/propertiesList own or effective asset propertiesDELETE/v1/model/assets/{uuid}/properties/{key}Clear an asset property overridePUT/v1/model/assets/{uuid}/properties/{key}Set an asset propertyPOST/v1/model/attributesCreate an attribute instanceGET/v1/model/attributes/{uuid}Read an effective attributePATCH/v1/model/attributes/{uuid}Retire an attribute instanceGET/v1/model/attributes/{uuid}/bindingsRead an attribute binding timelinePOST/v1/model/bindingsBind, rebind, unbind, or splice-revert a seriesGET/v1/model/calc/rulesList calculation rulesPOST/v1/model/calc/rulesCreate a calculation ruleGET/v1/model/calc/rules/{id}Read a calculation rulePUT/v1/model/calc/rules/{id}Create a new calculation rule versionPOST/v1/model/calc/rules/{id}/retireRetire a calculation ruleGET/v1/model/calc/rules/{id}/versionsList calculation rule versionsGET/v1/model/eventsRead the model transaction event feedPOST/v1/model/events/subscribeSubscribe to permission-filtered model eventsGET/v1/model/healthzReport model database readinessGET/v1/model/jobsList model jobsPOST/v1/model/jobsCreate and preview a model jobGET/v1/model/jobs/{id}Read a model jobPOST/v1/model/jobs/{id}/commitCommit a previewed model jobPOST/v1/model/linksCreate an asset linkPATCH/v1/model/links/{uuid}Retire or restore an asset linkGET/v1/model/lintsList open model governance lintsGET/v1/model/registries/{kind}List a governed registryPOST/v1/model/registries/{kind}/entriesCreate a governed registry entryGET/v1/model/registries/{kind}/entries/{id}Read a governed registry entryPOST/v1/model/resolveResolve model selectors to assets, attributes, and binding segmentsGET/v1/model/resolve-pathResolve a composition pathGET/v1/model/stagingList staged unbound seriesGET/v1/model/templatesList templatesPOST/v1/model/templatesCreate a templateGET/v1/model/templates/{uuid}Read a templatePATCH/v1/model/templates/{uuid}Replace a template versionGET/v1/model/treeRead the composition treeGET/v1/model/viewsList viewsPOST/v1/model/viewsCreate a viewGET/v1/model/views/{uuid}Read a viewPATCH/v1/model/views/{uuid}Rename or retire a viewGET/v1/model/views/{uuid}/treeRead a view tree

Operations2

Reads10

Series storage12

Service1

Streaming1