HTTP API: deploy

Nasazení (deployments), která tento repozitář deklaruje, čtená z kanonických objektů držených indexem, a zda by fungovala — posuzováno proti registru schopností, který tento proces postavil, a pracovnímu prostoru, v němž sedí. Každá operace je čtení: nasazení se mění důvěryhodným příkazovým řádkem a CI, nikdy přes HTTP a nikdy klientem MCP.

Vykresleno z docs/generated/openapi.json, který spustitelný soubor generuje ze svého registru schopností a CI jej odmítne, je-li zastaralý. Surový dokument je na /openapi.json; běžící server servíruje stejný dokument na vlastní /openapi.json a Swagger UI na /swagger.

deploy

GET /api/v1/deployment deploy.get

Jedno nasazení

Jedno nasazení podle své identity, typované, se souborem relativním k repozitáři, z něhož bylo čteno.

query
behaviorally_verified
vyžaduje se měření výkonu
cache vypnuta
Nástroj MCP majordomus_deployment

Parametry dotazu

název	typ	povinné	popis	příklady
id	string	ano	`id` nasazení.	first-deployment: "majordomus"

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/deployment?id=majordomus"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

status	tělo	význam
200	DeploymentView	Jedno nasazení: výsledek.
400	ErrorBody	`invalid_input`: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404	ErrorBody	`not_found`: Vstup pojmenovává něco, co repozitář nemá.
500	ErrorBody	`internal`: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí	ErrorBody	Jakékoli jiné selhání, které transport hlásí: 405 `method_not_allowed` pro jinou metodu na této cestě, 400 `invalid_input` pro tělo, které není objektem JSON.

GET /api/v1/deployments deploy.list

Nasazení

Každé nasazení, které vrstva deklaruje, typované: aplikace, dodaný balíček a binárka, adresa, na které proces naslouchá, trasy, které platforma dotazuje, zdroje, počet strojů, region, vstupy buildu a změřené rozpočty. Objekt druhu, který tento spustitelný soubor nedokáže přečíst, se ohlásí s důvodem, nepřeskočí se.

query
behaviorally_verified
vyžaduje se měření výkonu
cache vypnuta
Nástroj MCP majordomus_deployments
Zdroj MCP {"name": "deployments", "uri": "majordomus://deployments"}

Žádné parametry.

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/deployments"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

status	tělo	význam
200	DeploymentList	Nasazení: výsledek.
400	ErrorBody	`invalid_input`: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404	ErrorBody	`not_found`: Vstup pojmenovává něco, co repozitář nemá.
500	ErrorBody	`internal`: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí	ErrorBody	Jakékoli jiné selhání, které transport hlásí: 405 `method_not_allowed` pro jinou metodu na této cestě, 400 `invalid_input` pro tělo, které není objektem JSON.

GET /api/v1/deployments/check deploy.check

Zda by tato nasazení fungovala

Každé odmítnutí, které si deklarovaná nasazení lokálně vyslouží: trasa health, kterou neregistruje žádná schopnost, balíček nebo binárka, kterou workspace nevytváří, vstup buildu, který se nerozliší, víc běžících strojů, než existuje, hostovaný proces, který by se vázal na loopback. Každé jmenuje soubor, klíč, pozorovanou hodnotu a opravu. Nic zde nekontaktuje providera.

query
behaviorally_verified
vyžaduje se měření výkonu
cache process (max_entries=2, ttl_seconds=5)
Nástroj MCP majordomus_deploy_check

Žádné parametry.

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/deployments/check"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

status	tělo	význam
200	DeploymentCheck	Fungovala by tato nasazení: výsledek.
400	ErrorBody	`invalid_input`: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404	ErrorBody	`not_found`: Vstup pojmenovává něco, co repozitář nemá.
500	ErrorBody	`internal`: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí	ErrorBody	Jakékoli jiné selhání, které transport hlásí: 405 `method_not_allowed` pro jinou metodu na této cestě, 400 `invalid_input` pro tělo, které není objektem JSON.

GET /api/v1/deployments/observed deploy.observed

Co bylo nasazeno a kde

Každé nasazení, které forge zaznamenal, do každého prostředí, v němž nějaké má — mimo jiné GitHub Pages — s commitem, refem, tím, kdo je vytvořil, jak skončilo, kde se servíruje a během, který je provedl; každé prostředí popsané jeho nejnovějším nasazením; a každý release, který forge publikoval. Čte se ze záznamu, který zapsal `majordomus served forge`, když se forge naposledy ptal: nic zde nesahá na síť a checkout, který se nikdy neptal, odpoví `observed: false` s tím, co spustit.

query
behaviorally_verified
vyžaduje se měření výkonu
cache vypnuta
Nástroj MCP majordomus_deployments_observed

Žádné parametry.

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/deployments/observed"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

status	tělo	význam
200	ObservedDeployments	Co bylo nasazeno a kde: výsledek.
400	ErrorBody	`invalid_input`: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404	ErrorBody	`not_found`: Vstup pojmenovává něco, co repozitář nemá.
500	ErrorBody	`internal`: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí	ErrorBody	Jakékoli jiné selhání, které transport hlásí: 405 `method_not_allowed` pro jinou metodu na této cestě, 400 `invalid_input` pro tělo, které není objektem JSON.

Schémata

Komponenty, které používají jen operace tohoto tagu. Každý řádek je pole daného typu, jeho doc komentář je popis; typ vlastněný jinou stránkou na ni odkazuje.

Rozpočty

object

Změřené hodnoty, jimž je toto nasazení podřízeno. Každou zapisuje běh, který ji měřil; chybějící ještě nebyla změřena a není povolením.

vlastnost	typ	povinné	popis
image_bytes	Positive \| null → Positive	ne	Největší přijatá velikost komprimovaného obrazu.
binary_bytes	Positive \| null → Positive	ne	Největší přijatá velikost stripnuté binárky.
build_context_bytes	Positive \| null → Positive	ne	Největší přijatý kontext sestavení.
cold_start_ms	Positive \| null → Positive	ne	Nejdelší přijatá doba od zastaveného stroje k obsloužené odpovědi.
resident_memory_mb	Positive \| null → Positive	ne	Největší přijatá rezidentní množina pod zátěží.
blocking_check_ms	Positive \| null → Positive	ne	Nejdelší přijatý čas jedné kontroly liveness nebo readiness.
request_p99_ms	Positive \| null → Positive	ne	Nejdelší přijatý p99 pro obsloužený požadavek.

Používá DeploymentView

Build

object

Co se dodává a z čeho je to postaveno.

vlastnost	typ	povinné	popis
balíček	string	ano	Balíček Cargo, který se sestavuje.
binárka	string	ano	Cílová binárka, kterou image spouští.
profil	string	ano	Profil Cargo, pod nímž se obraz sestavuje.
vstupy	array of string	ano	Cesty relativní k repozitáři, které build kontext nese, a jen ty.
web	string \| null	ne	Adresář, do kterého zapisuje kanonický pipeline webu; jeho absence znamená, že image žádný web neobsluhuje.

Používá DeploymentView

CpuKind

"shared" | "performance"

Co je CPU stroje.

sharedZlomek jádra: levný profil.
performanceVyhrazená.

Používá Resources

DeploymentCheck

object

Zda by nasazení, která tento repozitář deklaruje, fungovala, rozhodnuto lokálně: vůči registru schopností, který tento proces sestavil, a pracovišti, v němž sídlí.

vlastnost	typ	povinné	popis
ok	boolean	ano	Pravda, když žádné nasazení nezasloužilo odmítnutí.
rozhodnuto	integer (uint)	ano	Kolik nasazení bylo rozhodnuto.
odmítnutí	pole Refusal → Refusal	ano	Každé odmítnutí, v pořadí, v jakém se objevují objekty a jejich klíče.

Používá deploy.check

DeploymentList

object

Každé nasazení, které vrstva deklaruje.

vlastnost	typ	povinné	popis
počet	integer (uint)	ano	Kolik.
nasazení	pole DeploymentView → DeploymentView	ano	Každý, v pořadí identity.
nečitelné	pole Refusal → Refusal	ne	Objekty druhu nasazení, které tento spustitelný soubor nedokázal přečíst, s důvodem. Poškozený objekt je zde nahlášen, ne skryt tím, že se přeskočil.

Používá deploy.list

DeploymentStatus

"declared" | "active" | "retired"

Kde nasazení stojí.

Status je správné jméno uvnitř tohoto modulu; jmenný prostor komponent schématu je plochý a distribution::Status odpovídá na jinou otázku, takže každé říká, které z nich je.

declaredObjekt existuje a zatím se z něj nic nenasazuje.
activeJe nasazeno.
retiredBylo, a objekt se uchovává pro záznam.

Používá DeploymentView

DeploymentView

object

Jedno nasazení tak, jak je tento proces čte, spolu s tím, odkud pochází.

vlastnost	typ	povinné	popis
soubor	string	ano	Soubor relativní k repozitáři, v němž objekt žije.
schema	string	ano	Verze formátu; verze, kterou tento spustitelný soubor nečte, se odmítne.
druh	string	ano	Vždy `deployment`.
id	string	ano	Identita v rámci repozitáře.
název	string	ano	Jeden řádek, který jej pojmenovává.
popis	string \| null	ne	Jeden řádek: co slouží a komu.
status	DeploymentStatus \| null → DeploymentStatus	ne	Jak to stojí.
aplikace	string	ano	Název aplikace: jak je nasazení známo ve výpisu.
build	Build → Build	ano	Co se dodává a z čeho je to postaveno.
listen	Listen → Listen	ano	Adresa, na které proces naslouchá.
zdraví	HealthRoutes → HealthRoutes	ano	Routy, které platforma dotazuje.
zdroje	Resources → Resources	ano	Co má jeden stroj povoleno.
stroje	Machines → Machines	ano	Kolik strojů běží.
region	string	ano	Oblast, v níž běží.
rozpočty	Budgets → Budgets	ne	Naměřené hodnoty, jimž podléhá.
created_at	string \| null	ne	Kdy byl objekt zapsán.
updated_at	string \| null	ne	Kdy byl naposledy změněn.

Používají deploy.get DeploymentList

EnvironmentSummary

object

Jedno prostředí, jak ho popisují jeho nasazení.

vlastnost	typ	povinné	popis
název	string	ano	Prostředí.
nasazení	integer (uint)	ano	Kolik z pozorovaných nasazení do něj šlo.
state	string	ano	Stav jeho nejnovějšího nasazení.
sha	string	ano	Commit, který tam dal jeho nejnovější deployment.
deployed_at	string	ano	Kdy to bylo.
url	string \| null	ne	Kde je obsluhováno, když to říká jeho nejnovější nasazení.
activity_url	string	ano	Aktivita prostředí na forge.

Používá ObservedDeployments

HealthRoutes

object

Trasy, které platforma dotazuje, a jak často.

vlastnost	typ	povinné	popis
živost	Trasa → Trasa	ano	Zda je tento proces živý.
připravenost	Trasa → Trasa	ano	Může tento proces obsluhovat provoz.
grace_seconds	integer \| null	ne	Jak dlouho platforma čeká, než se první kontrola započítá.
interval_seconds	Positive \| null → Positive	ne	Jak často platforma testuje živost.
timeout_seconds	Positive \| null → Positive	ne	Jak dlouho smí jedna kontrola trvat, než se počítá jako neúspěšná.

Používá DeploymentView

Rozhraní

"loopback" | "all"

Na kterém rozhraní proces naslouchá.

loopbackDosažitelné jen z tohoto hostitele: lokální výchozí hodnota a to, co si ponechává každé lokální vyvolání.
allKaždé rozhraní. Hostovaný proces to potřebuje a lokální nikdy; uvedení je záměr, který nahrazuje potlačení varování o bind.

Používá Listen

Naslouchání

object

Adresa, na které proces naslouchá.

vlastnost	typ	povinné	popis
port	Port → Port	ano	Port, uvedený jednou pro proces i obraz.
rozhraní	Interface → Interface	ano	Které rozhraní.

Používá DeploymentView

Stroje

object

Kolik strojů běží a zda je platforma smí zastavit.

vlastnost	typ	povinné	popis
počet	Positive → Positive	ano	Kolik strojů má aplikace.
min_running	integer (uint32)	ano	Kolik jich při nečinnosti zůstává běžet.
autostart	boolean	ano	Zda požadavek na zastavený stroj stroj spustí.
autostop	boolean	ano	Zda se nečinný stroj zastaví.

Používá DeploymentView

ObservedDeployment

object

Jedno nasazení, které forge zaznamenal.

vlastnost	typ	povinné	popis
id	string	ano	Identita nasazení u forge.
prostředí	string	ano	Prostředí, do kterého se šlo, slovy forge (`github-pages`, `production`, ...).
sha	string	ano	Commit, který byl nasazen.
git_ref	string \| null	ne	Ref, ze kterého bylo nasazeno, pokud ho forge ještě uvádí.
created_at	string	ano	Kdy byl vytvořen, RFC 3339.
tvůrce	string \| null	ne	Kdo nebo co to vytvořilo.
state	string	ano	Jak skončil, malými písmeny tak, jak to uvádí forge (`success`, `failure`, `in_progress`, ...); `unknown`, když forge nehlásil žádný stav.
environment_url	string \| null	ne	Kde je prostředí obsluhováno, pokud to nasazení říká.
log_url	string \| null	ne	Běh, který jej provedl, pokud to nasazení uvádí.

Používá ObservedDeployments

ObservedDeployments

object

deploy.observed: co bylo nasazeno kam, nebo že zde nebylo nic pozorováno.

vlastnost	typ	povinné	popis
pozorováno	boolean	ano	Zda tento checkout vůbec drží nějaké pozorování.
důvod	string \| null	ne	Proč ne a co spustit, když žádný nedrží nebo ho nelze přečíst.
repozitář	string \| null	ne	`owner/name`, pokud bylo pozorováno.
repository_url	string \| null	ne	Adresa repozitáře na forge, když byla pozorována.
observed_at	string \| null	ne	Kdy se forge ptalo, když bylo pozorováno.
prostředí	pole EnvironmentSummary → EnvironmentSummary	ano	Každé prostředí, do kterého se cokoli nasadilo, podle jména.
nasazení	pole ObservedDeployment → ObservedDeployment	ano	Pozorovaná nasazení, nejnovější první.
releases	pole ObservedRelease → ObservedRelease	ano	Pozorované releasy, nejnovější první.

Používá deploy.observed

ObservedRelease

object

Jeden release publikovaný forge.

vlastnost	typ	povinné	popis
štítek	string	ano	Tag.
název	string \| null	ne	Název release, pokud nějaký má.
published_at	string \| null	ne	Kdy byl publikován; u konceptu chybí.
url	string	ano	Jeho stránka na forge.
prerelease	boolean	ano	Zda ho forge označuje jako pre-release.
koncept	boolean	ano	Zda je to stále koncept.

Používá ObservedDeployments

Port

celé číslo (uint16)

Port TCP, který smí nasazený proces navázat. Privilegované porty mezi ně nepatří: proces běží jako uživatel bez roota a žádný by nenavázal.

Používá Listen

Pozitivní

integer (uint32)

Počet, který je alespoň jedna: paměť v megabajtech, CPU, stroje. Nula se odmítá všude, kde by nula znamenala „nasazení, které nemůže běžet“.

Používá Budgets HealthRoutes Machines Resources

Odmítnutí

object

Proč se objekt nasazení odmítá: co bylo čteno, kde a co s tím dělat.

vlastnost	typ	povinné	popis
soubor	string	ano	Soubor relativní k repozitáři, odkud hodnota pochází.
klíč	string	ano	Cesta klíče v něm, jak ji pojmenovává smlouva.
nalezeno	string	ano	Pozorovaná hodnota, vykreslená tak, jak byla přečtena.
problém	string	ano	Co je s ním špatně, v jednom řádku.
oprava	string	ano	Co dělat místo toho.

Používá DeploymentCheck DeploymentList

Zdroje

object

Co má jeden stroj povoleno.

vlastnost	typ	povinné	popis
cpu_kind	CpuKind → CpuKind	ano	Sdílený, nebo vyhrazený.
cpus	Positive → Positive	ano	Kolik CPU má jeden stroj.
memory_mb	Positive → Positive	ano	Paměť na stroj, v megabajtech.

Používá DeploymentView

Cesta

string

Routa, kterou platforma sonduje: absolutní cesta na této službě, nikdy URL. Hostitele zná nasazení a objekt jej nemá uvádět.

Používá HealthRoutes