Runtime Cloud — 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.

IaCProvisioningService

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/provisioning/specifications	ListSpecifications	factory.provisioning.read	read	natural	GW-03	Desired-state specifications per environment with versions and program references.
GET	/factory/provisioning/runs	ListProvisioningRuns	factory.provisioning.read	read	natural	GW-03	Provisioning runs by environment, kind and state with plan and apply receipts.
GET	/factory/provisioning/runs/{provisioningRunId}	GetProvisioningRun	factory.provisioning.read	read	natural	GW-03	One run with its plan, approval, apply receipt and logs.
POST	/factory/provisioning/runs	PlanProvisioning	factory.provisioning.apply	production	key-header	GW-03	Plan a specification version against an environment (baseline, reconciliation, decommission); production applies wait for the approval (Operator, Platform admin).
POST	/factory/provisioning/runs/{provisioningRunId}/cancel	CancelProvisioning	factory.provisioning.apply	shared-write	natural	GW-03	Cancel a planned run before apply.

gRPC (code-first, internal)

gRPC service	Method	Streaming	Visibility	Side effects	Summary
Provisioning	GetCurrentSpecification	none	internal	read	The specification version last applied to an environment (promotion, inventory and fleet read it).

RuntimeCloudHost

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

Method	Path	Operation	Scope	Side effects	Idempotency	Gateway	Summary
GET	/runtime-cloud/health	RuntimeCloudHealth	factory.health.read	read	natural	GW-01	Liveness, readiness and dependency health (runtime-cloud store, IaC runner, cluster API, Config Platform, inbox lag).
GET	/runtime-cloud/meta/targets	RuntimeCloudTargets	factory.meta.read	read	natural	GW-03	Provisioning targets configured per installation (Azure subscriptions, clusters, on-prem endpoints) and the IaC runner version.

ExecutionCapacityService

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/capacity/pools	ListWorkerPools	factory.capacity.read	read	natural	GW-03	Pools with kind, boundary, region, size and utilisation.
PUT	/factory/capacity/pools/{poolId}	SetWorkerPool	factory.capacity.admin	production	natural	GW-03	Create or change a pool's bounds and autoscaling (Platform admin; applied through provisioning).
GET	/factory/capacity/quotas	GetQuotas	factory.capacity.read	read	natural	GW-03	Effective quotas for the tenant and its projects with the edition source.
PUT	/factory/capacity/quotas/{scope}	SetQuota	factory.capacity.admin	shared-write	natural	GW-03	Tighten a project or tenant quota (Workspace admin) or set edition defaults (Platform admin).
GET	/factory/capacity/leases	ListCapacityLeases	factory.capacity.read	read	natural	GW-03	Active and recent leases by holder, pool and state (Operator view of who is using what).

gRPC (code-first, internal)

gRPC service	Method	Streaming	Visibility	Side effects	Summary
Capacity	AcquireLease	none	internal	shared-write	Request capacity for an attempt, sandbox, build or browser session; returns the pool and lease or the limiting quota.
Capacity	RenewLease	none	internal	shared-write	Heartbeat renewal.
Capacity	ReleaseLease	none	internal	shared-write	Release on completion.

RuntimeEnvironmentService

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/environments/{environmentId}/inventory	GetRuntimeInventory	factory.runtime.read	read	natural	GW-03	Observed workloads, versions, replicas, endpoints and bindings by reference, with staleness.
GET	/factory/environments/{environmentId}/drift	ListDrift	factory.runtime.read	read	natural	GW-03	Open and resolved drift findings for an environment.
POST	/factory/environments/{environmentId}/observe	ObserveEnvironment	factory.runtime.operate	read	natural	GW-03	Trigger an observation now (Operator).
GET	/factory/reconciliation/proposals	ListReconciliationProposals	factory.runtime.read	read	natural	GW-03	Proposals by environment and state with plan summaries.
POST	/factory/reconciliation/proposals/{proposalId}/decide	DecideReconciliation	factory.runtime.operate	production	natural	GW-03	Accept (plans a provisioning run) or reject with a reason (Operator; production acceptance is production class).

gRPC (code-first, internal)

gRPC service	Method	Streaming	Visibility	Side effects	Summary
Inventory	GetObservedState	none	internal	read	Observed state of an environment for promotion verification and fleet inventory.