Product Fleet Operations — 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.
FleetIncidentService¶
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/fleet/incidents |
ListIncidents | factory.fleet.read |
read | natural | GW-03 | Incidents by product, severity and state. |
GET |
/factory/fleet/incidents/{incidentId} |
GetIncident | factory.fleet.read |
read | natural | GW-03 | One incident with timeline, links, notifications and review. |
POST |
/factory/fleet/incidents |
OpenIncident | factory.fleet.operate |
shared-write | key-header | GW-03 | Open an incident manually (Operator) or from an alert rule. |
POST |
/factory/fleet/incidents/{incidentId}/transition |
TransitionIncident | factory.fleet.operate |
shared-write | natural | GW-03 | Acknowledge, mitigate (with the rollout or promotion reference), resolve, record the review. |
GET |
/factory/fleet/on-call |
ListOnCall | factory.fleet.read |
read | natural | GW-03 | On-call records by product and window. |
PUT |
/factory/fleet/on-call/{recordId} |
SetOnCall | factory.fleet.admin |
shared-write | natural | GW-03 | Create or change an on-call record. |
POST |
/factory/fleet/offboardings |
RequestOffboarding | factory.fleet.admin |
production | key-header | GW-03 | Request off-boarding of a customer tenant or a product (approval, export, handover, deletion). |
POST |
/factory/fleet/offboardings/{offboardingId}/acknowledge-handover |
AcknowledgeHandover | factory.fleet.admin |
shared-write | natural | GW-03 | The customer (or the owner on their written waiver) acknowledges the export; deletion may start. |
GET |
/factory/fleet/offboardings/{offboardingId} |
GetOffboarding | factory.fleet.read |
read | natural | GW-03 | State with export, handover and deletion order references. |
FleetInventoryService¶
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/fleet/products |
ListOperatedProducts | factory.fleet.read |
read | natural | GW-03 | Operated products with edition, current release, instance counts and health rollup. |
GET |
/factory/fleet/products/{productId} |
GetOperatedProduct | factory.fleet.read |
read | natural | GW-03 | One product with instances per customer tenant and environment, releases, objectives and health. |
POST |
/factory/fleet/products |
OnboardProduct | factory.fleet.admin |
shared-write | key-header | GW-03 | Onboard a generated product into fleet operation under a managed edition (subscription required; Workspace admin of the owning tenant). |
GET |
/factory/fleet/products/{productId}/instances |
ListProductInstances | factory.fleet.read |
read | natural | GW-03 | Instances with state, release, region and health. |
PUT |
/factory/fleet/products/{productId}/objectives/{kind} |
SetProductObjective | factory.fleet.admin |
shared-write | natural | GW-03 | Define or tighten a product objective (registered with SloService). |
gRPC (code-first, internal)
| gRPC service | Method | Streaming | Visibility | Side effects | Summary |
|---|---|---|---|---|---|
Fleet |
GetInstance |
none | internal | read | Resolve an instance for rollouts and incidents. |
FleetOperationsHost¶
REST (public endpoints need a scope; every call carries trusted tenant and project scope)
| Method | Path | Operation | Scope | Side effects | Idempotency | Gateway | Summary |
|---|---|---|---|---|---|---|---|
GET |
/fleet/health |
FleetHealth | factory.health.read |
read | natural | GW-01 | Liveness, readiness and dependency health (fleet store, delivery, runtime cloud, observability, inbox lag). |
GET |
/fleet/meta/summary |
FleetSummary | factory.meta.read |
read | natural | GW-03 | Fleet-wide counts: operated products, instances by environment class, open incidents, active rollouts. |
FleetRolloutService¶
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/fleet/rollouts |
ListRollouts | factory.fleet.read |
read | natural | GW-03 | Rollouts by product, kind and state with wave progress. |
GET |
/factory/fleet/rollouts/{rolloutId} |
GetRollout | factory.fleet.read |
read | natural | GW-03 | One rollout with waves, promotions, guards, approval and evidence. |
POST |
/factory/fleet/rollouts |
PlanRollout | factory.fleet.operate |
production | key-header | GW-03 | Plan a rollout (waves, bake, guards) of a release, template or library upgrade or a re-scaffold; production waves are production class. |
POST |
/factory/fleet/rollouts/{rolloutId}/resume |
ResumeRollout | factory.fleet.operate |
production | natural | GW-03 | Resume a halted rollout after the Operator judged the breach (production class). |
POST |
/factory/fleet/rollouts/{rolloutId}/rollback |
RollbackRollout | factory.fleet.operate |
production | natural | GW-03 | Roll back the current wave (and optionally completed waves) to the previous release. |
POST |
/factory/fleet/rollouts/{rolloutId}/cancel |
CancelRollout | factory.fleet.operate |
shared-write | natural | GW-03 | Cancel a planned rollout. |