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"
# okReference
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
POST
/v1/annotationsCreate an annotationGET/v1/annotations/{id}Read an annotationPUT/v1/annotations/{id}Edit an annotationPOST/v1/annotations/{id}/redactRedact annotation contentGET/v1/annotations/{id}/versionsList annotation versionsPOST/v1/annotations/attachmentsUpload an annotation attachmentGET/v1/annotations/attachments/{id}Download an annotation attachmentPOST/v1/annotations/queryQuery annotationsAuthentication22
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 principalCalculations7
POST
/v1/calc/backfillCreate a calculation backfillGET/v1/calc/backfill/{job_id}Read calculation backfill progressPOST/v1/calc/backfill/{job_id}/cancelCancel a calculation backfillPOST/v1/calc/backfill/{job_id}/commitCommit a preview calculation backfillGET/v1/calc/lineageRead calculation lineage at a series instantGET/v1/calc/rules/{rule_id}/statusRead calculation instance healthGET/v1/calc/rules/{rule_id}/traceRead calculation evaluation traceCollectors and jobs3
Contract1
Displays13
GET
/v1/display-foldersList child display foldersPOST/v1/display-foldersCreate a display folderGET/v1/display-folders/{id}Read a display folderPUT/v1/display-folders/{id}Rename a display folderGET/v1/displaysList readable display documentsPOST/v1/displaysSave a new display documentGET/v1/displays/{id}Read a display documentPUT/v1/displays/{id}Save a new version of a display documentGET/v1/displays/{id}/exportExport a canonical display documentGET/v1/displays/{id}/lintLint a stored display documentGET/v1/displays/resolveResolve a saved or generated display for an assetPOST/v1/displays/time/navigator-contextResolve a calendar-aware navigator context windowPOST/v1/displays/time/resolveResolve display time expressions exactlyEpisodes13
POST
/v1/episodesCreate an episodeGET/v1/episodes/{id}Read an episodePUT/v1/episodes/{id}Edit an episodePOST/v1/episodes/{id}/closeClose an open episodeGET/v1/episodes/{id}/linksList episode genealogy linksPOST/v1/episodes/{id}/linksCreate an episode genealogy linkPOST/v1/episodes/{id}/voidVoid an episodePOST/v1/episodes/queryQuery episodesGET/v1/episodes/templatesList episode templatesPOST/v1/episodes/templatesCreate an episode templateGET/v1/episodes/templates/{id}Read an episode templatePUT/v1/episodes/templates/{id}Revise an episode templatePOST/v1/episodes/traverseTraverse episode genealogyModel45
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 treeOperations2
Reads10
POST
/v1/read/as-ofRead the arrival-time view through model bindingsPOST/v1/read/atEvaluate attributes at explicit instantsPOST/v1/read/episode-overlayNormalize closed episodes onto a 0..1 comparison gridPOST/v1/read/rawRead raw points through model bindingsPOST/v1/read/raw-auditRead all revisions through model bindingsPOST/v1/read/renderRender model-addressed attributes for a pixel widthPOST/v1/read/sampledEvaluate attributes on a regular sample gridPOST/v1/read/snapshotRead the current point through model bindingsPOST/v1/read/subscribeSubscribe to resolved live updates over SSEPOST/v1/read/summaryCalculate windowed summaries through model bindingsSeries storage12
GET
/v1/seriesList registered series visible to the callerGET/v1/series/{uuid}/chunksList storage chunks for a series and rangeGET/v1/series/{uuid}/finalisedRead the finalisation watermarkGET/v1/series/{uuid}/gapsRead recorded gap markersGET/v1/series/{uuid}/lifecycle-policyRead a series lifecycle policyPUT/v1/series/{uuid}/lifecycle-policyReplace a series lifecycle policyGET/v1/series/{uuid}/rawRead merged raw series pointsGET/v1/series/{uuid}/raw-auditRead every stored revision in audit orderGET/v1/series/{uuid}/renderRender a numeric series for a pixel widthGET/v1/series/{uuid}/rollupsRead stored rollup rowsGET/v1/series/{uuid}/snapshotRead the latest series pointPUT/v1/series/{uuid}/writable-classSet the series writable classService1
Streaming1
Related topics
- Authentication — get credentials for protected endpoints.
- Wire conventions — handle timestamps, errors, pagination, and idempotency consistently.
- OpenAPI contract — download the machine-readable version of this reference.