Skip to content
SENS Platform Docs
API
Platform
Technical
Internal
Search
Ctrl
K
Cancel
Select language
English
Deutsch
API
API
Getting Started
Authentication
Interactive API console
Core Administration API
Resource Inventory API
Audit API
Errors
Examples
Reference
Overview
Diagnostics
Overview
Return the deployed platform version.
Exercise the platform API request path.
Return the service health state.
Return service readiness and dependency checks.
Return Prometheus metrics for the service.
Authentication
Overview
Create a local password session.
Rotate the current refresh token.
Revoke the refresh session and clear its cookie.
Revoke every session for the authenticated user.
Return the current user, session, roles, and membership grants.
List the authenticated user's active sessions.
Revoke one session owned by the authenticated user.
Replace the local password and every existing session.
Devices
Overview
List devices visible in the caller's organization scope.
Create a device, optionally with its initial organization assignment.
Read one scope-visible device.
Update the controlled device lifecycle or mutable fields.
Read the current value snapshot for all active fields of a visible Device.
Read bounded historical measurements for one visible Device.
List assignment periods visible in the caller's organization scope.
Assign or immediately move a device to one organization unit.
End the current assignment as a platform or tenant administrator.
Device types
Overview
List tenant device types.
Create a device type with an immutable key.
Read one tenant device type.
Update a device type without changing its key.
List the authoritative data-field contract of a Device Type.
Create or compatibly update one Device Type data field.
Deprecate a data field without deleting its history.
Telemetry flows
Overview
List visible immutable block versions and their JSON Schemas.
Create a global custom-script block as a platform administrator.
Resolve one immutable released or deprecated Custom-block version for a pinned Flow graph.
List versions of one visible global or tenant custom block without compiled artifacts.
Create an immutable draft for the addressed global or tenant custom block.
List global custom-script blocks as a platform administrator.
Read one custom-block version including source but excluding its artifact.
Run technical compile and sandbox gates, then directly release the draft.
Deprecate a released block version for new flow releases.
List tenant-owned custom-script blocks as a platform or tenant administrator.
Create a tenant-owned custom-script block as a platform or tenant administrator.
List global flow templates.
Create a global flow template.
List immutable global template versions.
Create a global template draft from a flow graph.
Validate a template and reject tenant-block dependencies.
Release an immutable template version.
Deprecate a template for future copies.
Copy a released platform template into an independent tenant draft.
List tenant-owned telemetry flows.
Atomically create the single telemetry Flow and initial V2 draft for a Device Type.
Read one authorized telemetry Flow for exact selector restoration.
List immutable flow versions.
Create an immutable draft flow version.
Compile and validate a draft flow version.
Release a valid draft directly without four-eyes approval.
Atomically activate or roll back to a released flow version.
List materialized test fixtures for a tenant flow.
Save a materialized fixture; Raw inputs require explicit retention confirmation.
Replace one fixture with optimistic concurrency.
Delete one fixture with optimistic concurrency.
Execute a synchronous, side-effect-free preview against Raw, manual or fixture input.
List tenant, device-type and device overrides for one flow.
Create or replace one context-specific parameter value.
Delete one context override and expose the next fallback.
Resolve Device, Device Type, Tenant and default values for diagnostics.
Queue an idempotent replay pinned to a released or deprecated version.
List live and replay execution diagnostics.
Read one tenant-isolated execution and its pinned context.
Flow actions
Overview
List logical tenant E-mail templates and active pointers.
Create a logical tenant E-mail template.
List immutable E-mail template versions.
Create and parse-check an E-mail template draft.
Release an immutable E-mail template version.
Deprecate an E-mail template version for future activation.
Move the active template pointer with optimistic concurrency.
List explicit recipient and disabled bindings.
Read one exact tenant-scoped recipient binding for optimistic editing.
Store a recipients or disabled binding; the most specific row replaces fallback.
Delete one binding with optimistic concurrency.
Read the tenant Action kill-switch.
Pause or resume tenant Actions without deleting jobs.
List persistent flow and Action Dead Letters.
Read one persistent Dead Letter.
Manually redrive an open Dead Letter while preserving pinned data.
Raw ingestion
Overview
Query raw ingestion metadata as a platform administrator.
Load one raw-ingestion message including exact payloads.
Core administration
List tenants visible to the authenticated actor.
Create a tenant as a platform administrator.
Read one visible tenant.
Soft-disable a tenant as a platform administrator.
Update an authorized tenant.
List all accessible organization units and navigation ancestors.
Create an organization unit in an administrable scope.
List accessible root organization units and navigation ancestors.
Search the complete visible organization hierarchy.
List the direct visible children of an organization unit.
Read an accessible unit or navigation ancestor.
Soft-disable an organization subtree.
Update, reparent, disable, or reactivate an organization unit.
User administration
List global users as a platform administrator.
Provision a global local-password user.
Read one global user.
Soft-disable a user and revoke all sessions.
Update or reactivate a global user.
Set a temporary password and revoke all sessions.
Grant the global platform administrator role.
Revoke the global platform administrator role.
List users with membership history in a tenant.
Read a user with tenant membership history.
Membership administration
List tenant membership grants and their history.
Create a tenant membership grant.
Read one membership grant.
Soft-disable a membership grant.
Update, disable, or reactivate a membership grant.
Audit
Query global audit events as a platform administrator.
Query safely tenant-scoped audit events.
Administration
Import a temporary create-only snapshot from IOTA.
Platform
Platform
Sign in and orientation
Overview
Tenants and organizations
Users and permissions
Devices
Device Types and Telemetry Flows
Raw data
Audit
Platform administration
Technical
Technical
Services and components
Services and components
web-console
platform-api
mqtt-ingestion-worker
raw-storage-worker
flow-worker
script-sandbox-worker
flow-action-worker
documentation service
Platform components
Architecture
Backup and Restore
Data Model
Versioned Telemetry Flows
Deployment Model
Device Ingestion Architecture
Frontend Design System
Module Boundaries
Observability Model
Security Model
System Overview
Tenancy and Organization Model
Contracts
Platform Release Version
Telemetry Flow Contracts V1
Export Contract V1
MQTT Network Server Ingestion Contract V1
IOTA snapshot import v1
Telemetry API Contract V1
ADRs
ADR-0001: Platform Stack
ADR-0002: Service Structure
ADR-0003: PostgreSQL and TimescaleDB
ADR-0004: Internal Broker
ADR-0005: Tenant and Organization Model
ADR-0007 Authentication and Authorization V1
ADR-0008 Fail-Closed Audit and Break-Glass Administration
ADR-0009 Visual Telemetry Flows
ADR-0010 Device-Type Field Contract and Storage Sinks
ADR-0011 Public Tenant Numbers and Hybrid Resource Routes
ADR-0012 Source Monorepo, GitOps Separation, and Management-Plane Topology
Operations
Local Development
Runtime Configuration
Secret Management
Argo CD Applications
Database Migrations
Kubernetes Test and Production Deployment
Netmore Raw Ingestion
Raw Stored Work-Queue Migration
Troubleshooting
Dependency Policy
Documentation guidelines
Internal
Internal
Development principles
Roadmap
SENS Cloud and SENS Ops rollout plan
Future concepts
Open decisions
Select language
English
Deutsch
Overview
Authentication
Section titled “Authentication”
User and API-client authentication flows.
Operations
Section titled “Operations”
POST
/v1/auth/login
POST
/v1/auth/refresh
POST
/v1/auth/logout
POST
/v1/auth/logout-all
GET
/v1/auth/me
GET
/v1/auth/sessions
DELETE
/v1/auth/sessions/{sessionId}
POST
/v1/auth/change-password