Data & Event Platform — APIs

Generated from the architecture model

This page is rendered from model/**/*.yaml by tools/docs_model during mkdocs build. Edit the YAML, not this page; hand-written design lives on the linked service, platform and plane pages.

DataEventFoundations

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/data-event/health	DataEventHealth	factory.health.read	read	natural	GW-01	Liveness, readiness and dependency health (foundations store, transport, secret store).
GET	/data-event/meta/profiles	DataEventProfiles	factory.meta.read	read	natural	GW-03	The messaging profile and store profiles this installation runs, with adapter versions (ADR-0012, ADR-0013).

EnvelopeRegistryService

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/factory/data/topics	ListTopics	factory.data.read	read	natural	GW-03	Topics with producer, consumers, current schema version and state; filter by context or producer.
GET	/factory/data/topics/{topic}	GetTopic	factory.data.read	read	natural	GW-03	One topic with its schema versions and compatibility history.
PUT	/factory/data/topics/{topic}	RegisterTopic	factory.data.admin	production	natural	GW-03	Register or update a topic (Platform admin; normally applied from the architecture model by the release pipeline).
POST	/factory/data/topics/{topic}/schema-versions	PublishSchemaVersion	factory.data.admin	production	key-header	GW-03	Publish a payload schema version; breaking versions need every consumer's acknowledgement first.
GET	/factory/data/envelope-profiles	ListEnvelopeProfiles	factory.data.read	read	natural	GW-03	Envelope carriage per messaging profile with outbox and inbox contracts.

gRPC (code-first, internal)

gRPC service	Method	Streaming	Visibility	Side effects	Summary
Envelopes	ResolveTopic	none	internal	read	Resolve an event name to its topic, current schema version and state at publish time.
Envelopes	ValidateEnvelope	none	internal	read	Validate an envelope and payload against the registered schema version before it enters the outbox (optional strict mode).

StoreProfileService

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/factory/data/stores	ListStoreBindings	factory.data.read	read	natural	GW-03	Logical stores with owner, profile, region, backup class and state (the storage catalog at runtime).
GET	/factory/data/store-profiles	ListStoreProfiles	factory.data.read	read	natural	GW-03	Engine profiles per store class and topology.
PUT	/factory/data/stores/{storeId}	SetStoreBinding	factory.data.admin	production	natural	GW-03	Bind a logical store to a profile, region and key (Platform admin; applied by provisioning).

gRPC (code-first, internal)

gRPC service	Method	Streaming	Visibility	Side effects	Summary
Stores	ResolveBinding	none	internal	read	Resolve a logical store to its connection reference and region for a tenant (used by hosts at start-up and by provisioning).

RetentionResidencyService

REST (public endpoints need a scope; every call carries trusted tenant and project scope)

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/factory/data/retention	ListRetentionRules	factory.data.read	read	natural	GW-03	Effective retention per store class and classification for the tenant (platform defaults plus overrides).
PUT	/factory/data/retention/{storeClass}/{classification}	SetRetentionRule	factory.data.admin	shared-write	natural	GW-03	Shorten retention for the tenant (Workspace admin) or set a platform default (Platform admin).
GET	/factory/data/residency	GetResidency	factory.data.read	read	natural	GW-03	The tenant's region and allowed engines per class.
PUT	/factory/data/residency	SetResidency	factory.data.admin	production	natural	GW-03	Select the tenant's region (at tenant creation; later changes issue a migration order).
POST	/factory/data/orders	IssueGovernanceOrder	factory.data.admin	production	key-header	GW-03	Issue a deletion, purge, export or legal-hold order for a scope; tenant deletion is production-class and approval-gated.
GET	/factory/data/orders/{orderId}	GetGovernanceOrder	factory.data.read	read	natural	GW-03	Order state with per-owner tasks, receipts and the export bundle reference.
POST	/factory/data/orders/{orderId}/acknowledge	AcknowledgeOrderTask	factory.data.acknowledge	shared-write	natural	GW-03	An owning service acknowledges its task with a receipt (internal).

gRPC (code-first, internal)

gRPC service	Method	Streaming	Visibility	Side effects	Summary
Retention	EvaluateResidency	none	internal	read	Check a candidate store binding, model deployment or connector region against the tenant's residency rule.