Skip to content
Proud to collaborate with Microsoft for Startups

apphost.web.prepare ​

Resolve a hosted site and container image, claim shared compute if needed, and build Namespace/Deployment/Service/Ingress manifests pinned to pool apphost.

Build the pinned manifests for an AppHost process site.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-apphost
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
site_uuiduuidYes—Claimed AppHost site to run the process on
imagestringNo—Container image (registry/name:tag). Required unless repo is an image ref
repostringNo—Container repository ref, or a git URL (git build is not this verb)
portintegerNo8080Container and Service port (default 8080)
replicasintegerNo1Deployment replicas (1..8, default 1)
skustringNosmallShared size class for requests/limits (small

Output Schema ​

FieldTypeRequiredDefaultDescription
site_uuiduuidYes——
organization_uuiduuidNo——
machine_uuiduuidNo——
slugstringYes——
hoststringYes——
hostsjsonNo—Ingress hosts: platform slug plus issued/attached custom names
urlstringYes——
namespacestringYes——
imagestringYes——
repostringNo——
portintegerYes——
replicasintegerYes——
skustringYes——
connection_uuiduuidYes——
manifestsjsonYes——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—executeWill resolve the site and build manifests
completedNoYesYes—Manifests ready
failedNoYesNo—Prepare rejected

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
preparedSUCCESSManifests ready for k8s.manifest.syncurl, namespace, image
failedFAILUREApphost workflow failedfailure_reason

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "apphost.web.prepare",
  "initial_data": {
    "site_uuid": "value"
  }
}