[{"data":1,"prerenderedAt":493},["ShallowReactive",2],{"navigation":3,"\u002Freference\u002Fapi":194,"\u002Freference\u002Fapi-surround":488},[4,18,31,64,81,102,111,132,149],{"title":5,"path":6,"stem":7,"children":8,"page":17},"Getting started","\u002Fgetting-started","1.getting-started",[9,13],{"title":10,"path":11,"stem":12},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction",{"title":14,"path":15,"stem":16},"Run your first workflow","\u002Fgetting-started\u002Fquickstart","1.getting-started\u002F2.quickstart",false,{"title":19,"path":20,"stem":21,"children":22,"page":17},"Core concepts","\u002Fconcepts","2.concepts",[23,27],{"title":24,"path":25,"stem":26},"The platform model","\u002Fconcepts\u002Fplatform","2.concepts\u002F1.platform",{"title":28,"path":29,"stem":30},"Architecture and boundaries","\u002Fconcepts\u002Farchitecture","2.concepts\u002F2.architecture",{"title":32,"path":33,"stem":34,"children":35,"page":17},"Installation","\u002Finstallation","3.installation",[36,40,44,48,52,56,60],{"title":37,"path":38,"stem":39},"Overview and requirements","\u002Finstallation\u002Foverview","3.installation\u002F1.overview",{"title":41,"path":42,"stem":43},"Local evaluation","\u002Finstallation\u002Flocal-evaluation","3.installation\u002F2.local-evaluation",{"title":45,"path":46,"stem":47},"Install the server","\u002Finstallation\u002Fserver","3.installation\u002F3.server",{"title":49,"path":50,"stem":51},"Install a runner","\u002Finstallation\u002Frunner","3.installation\u002F4.runner",{"title":53,"path":54,"stem":55},"Verify the installation","\u002Finstallation\u002Fverification","3.installation\u002F5.verification",{"title":57,"path":58,"stem":59},"Upgrade the platform","\u002Finstallation\u002Fupgrades","3.installation\u002F6.upgrades",{"title":61,"path":62,"stem":63},"Guided installer","\u002Finstallation\u002Finstaller","3.installation\u002F7.installer",{"title":65,"path":66,"stem":67,"children":68,"page":17},"Build workflows","\u002Fworkflows","4.workflows",[69,73,77],{"title":70,"path":71,"stem":72},"Build a Definition","\u002Fworkflows\u002Fdefinitions","4.workflows\u002F0.definitions",{"title":74,"path":75,"stem":76},"Deploy and run workflows","\u002Fworkflows\u002Fruns","4.workflows\u002F1.runs",{"title":78,"path":79,"stem":80},"Inputs, context, and secrets","\u002Fworkflows\u002Finputs-and-secrets","4.workflows\u002F2.inputs-and-secrets",{"title":82,"path":83,"stem":84,"children":85,"page":17},"Run and recover","\u002Foperations","5.operations",[86,90,94,98],{"title":87,"path":88,"stem":89},"Monitor Runs","\u002Foperations\u002Fmonitoring","5.operations\u002F1.monitoring",{"title":91,"path":92,"stem":93},"Approve prepared steps","\u002Foperations\u002Fapprovals","5.operations\u002F2.approvals",{"title":95,"path":96,"stem":97},"Recover or cancel execution","\u002Foperations\u002Frecovery","5.operations\u002F3.recovery",{"title":99,"path":100,"stem":101},"Troubleshooting","\u002Foperations\u002Ftroubleshooting","5.operations\u002F4.troubleshooting",{"title":103,"path":104,"stem":105,"children":106,"page":17},"Action catalog","\u002Fcatalog","6.catalog",[107],{"title":108,"path":109,"stem":110},"Find and use Actions","\u002Fcatalog\u002Foverview","6.catalog\u002F1.overview",{"title":112,"path":113,"stem":114,"children":115,"page":17},"Administration","\u002Fadministration","7.administration",[116,120,124,128],{"title":117,"path":118,"stem":119},"Registries and Environments","\u002Fadministration\u002Fenvironments","7.administration\u002F2.environments",{"title":121,"path":122,"stem":123},"Manage runners","\u002Fadministration\u002Frunners","7.administration\u002F3.runners",{"title":125,"path":126,"stem":127},"Access and approval policies","\u002Fadministration\u002Faccess","7.administration\u002F4.access",{"title":129,"path":130,"stem":131},"Backups and upgrades","\u002Fadministration\u002Fmaintenance","7.administration\u002F5.maintenance",{"title":133,"path":134,"stem":135,"children":136,"page":17},"Develop Actions","\u002Factions","8.actions",[137,141,145],{"title":138,"path":139,"stem":140},"Build your first Action","\u002Factions\u002Fquickstart","8.actions\u002F1.quickstart",{"title":142,"path":143,"stem":144},"Local development","\u002Factions\u002Flocal-development","8.actions\u002F2.local-development",{"title":146,"path":147,"stem":148},"Publish an Action","\u002Factions\u002Fpublishing","8.actions\u002F3.publishing",{"title":150,"path":151,"stem":152,"children":153,"page":17},"Reference","\u002Freference","9.reference",[154,158,162,166,170,174,178,182,186,190],{"title":155,"path":156,"stem":157},"Operator CLI","\u002Freference\u002Foperator-cli","9.reference\u002F1.operator-cli",{"title":159,"path":160,"stem":161},"Installer CLI","\u002Freference\u002Finstaller-cli","9.reference\u002F10.installer-cli",{"title":163,"path":164,"stem":165},"Definition syntax","\u002Freference\u002Fdefinition","9.reference\u002F2.definition",{"title":167,"path":168,"stem":169},"CLI configuration","\u002Freference\u002Fconfiguration","9.reference\u002F3.configuration",{"title":171,"path":172,"stem":173},"API integration","\u002Freference\u002Fapi","9.reference\u002F4.api",{"title":175,"path":176,"stem":177},"Action CLI","\u002Freference\u002Faction-cli","9.reference\u002F5.action-cli",{"title":179,"path":180,"stem":181},"Action SDK","\u002Freference\u002Fsdk","9.reference\u002F6.sdk",{"title":183,"path":184,"stem":185},"Contracts and compatibility","\u002Freference\u002Fcontracts","9.reference\u002F7.contracts",{"title":187,"path":188,"stem":189},"Server configuration","\u002Freference\u002Fserver-configuration","9.reference\u002F8.server-configuration",{"title":191,"path":192,"stem":193},"Runner configuration","\u002Freference\u002Frunner-configuration","9.reference\u002F9.runner-configuration",{"id":195,"title":171,"body":196,"description":482,"extension":483,"meta":484,"navigation":485,"path":172,"seo":486,"stem":173,"__hash__":487},"docs\u002F9.reference\u002F4.api.md",{"type":197,"value":198,"toc":475},"minimark",[199,203,210,215,231,238,242,436,440,443,464],[200,201,202],"p",{},"The operator CLI uses the server's HTTP API. Integrations receive the same authorization, revision checks, execution policy enforcement, and retained evidence as interactive users.",[200,204,205,206,209],{},"For downloadable specifications, discovery, and compatibility rules, see ",[207,208,183],"a",{"href":184},".",[211,212,214],"h2",{"id":213},"connect-and-authenticate","Connect and authenticate",[200,216,217,218,222,223,226,227,230],{},"Use HTTPS and trust the server's certificate. ",[219,220,221],"code",{},"POST \u002Fv1\u002Flogin"," accepts a username\u002Fpassword and returns a token and expiry. Authenticated requests use ",[219,224,225],{},"Authorization: Bearer TOKEN","; ",[219,228,229],{},"POST \u002Fv1\u002Flogout"," revokes the session. Deliver credentials through your automation environment rather than committing them in scripts.",[200,232,233,234,237],{},"The running server exposes its generated OpenAPI document at ",[219,235,236],{},"\u002Fopenapi.json",". Use that document for exact schemas and response fields for the deployed platform version. The website's rendering fixtures are not an API contract.",[211,239,241],{"id":240},"main-endpoints","Main endpoints",[243,244,245,258],"table",{},[246,247,248],"thead",{},[249,250,251,255],"tr",{},[252,253,254],"th",{},"Method and path",[252,256,257],{},"Purpose",[259,260,261,272,282,292,302,312,322,332,342,352,366,376,386,396,406,416,426],"tbody",{},[249,262,263,269],{},[264,265,266],"td",{},[219,267,268],{},"GET \u002Fhealth",[264,270,271],{},"Health and server version",[249,273,274,279],{},[264,275,276],{},[219,277,278],{},"POST \u002Fv1\u002Fdeployments",[264,280,281],{},"Deploy a Definition using an expected revision and idempotency key",[249,283,284,289],{},[264,285,286],{},[219,287,288],{},"GET \u002Fv1\u002Fpyplines",[264,290,291],{},"List installed Pyplines",[249,293,294,299],{},[264,295,296],{},[219,297,298],{},"GET \u002Fv1\u002Fpyplines\u002F{environment}\u002F{name}",[264,300,301],{},"Inspect an installed revision",[249,303,304,309],{},[264,305,306],{},[219,307,308],{},"GET \u002Fv1\u002Fpyplines\u002F{environment}\u002F{name}\u002Fhistory",[264,310,311],{},"List revisions",[249,313,314,319],{},[264,315,316],{},[219,317,318],{},"POST \u002Fv1\u002Fruns",[264,320,321],{},"Start a Run with revision, inputs, and idempotency key",[249,323,324,329],{},[264,325,326],{},[219,327,328],{},"GET \u002Fv1\u002Fruns",[264,330,331],{},"List Runs",[249,333,334,339],{},[264,335,336],{},[219,337,338],{},"GET \u002Fv1\u002Fruns\u002F{id}",[264,340,341],{},"Inspect state and available execution evidence",[249,343,344,349],{},[264,345,346],{},[219,347,348],{},"GET \u002Fv1\u002Frunner-pools",[264,350,351],{},"List runner pools (administrator)",[249,353,354,359],{},[264,355,356],{},[219,357,358],{},"POST \u002Fv1\u002Frunner-pools",[264,360,361,362,365],{},"Create a pool with a ",[219,363,364],{},"name"," field (administrator)",[249,367,368,373],{},[264,369,370],{},[219,371,372],{},"GET \u002Fv1\u002Fruns\u002F{id}\u002Fhistory",[264,374,375],{},"Read Run events",[249,377,378,383],{},[264,379,380],{},[219,381,382],{},"GET \u002Fv1\u002Fruns\u002F{id}\u002Fattempts",[264,384,385],{},"Read execution attempts",[249,387,388,393],{},[264,389,390],{},[219,391,392],{},"GET \u002Fv1\u002Fruns\u002F{id}\u002Flogs\u002F{step}",[264,394,395],{},"Read retained non-private logs",[249,397,398,403],{},[264,399,400],{},[219,401,402],{},"POST \u002Fv1\u002Fruns\u002F{id}\u002Fapprove",[264,404,405],{},"Approve prepared work",[249,407,408,413],{},[264,409,410],{},[219,411,412],{},"POST \u002Fv1\u002Fruns\u002F{id}\u002Fretry",[264,414,415],{},"Retry a settled blocked step",[249,417,418,423],{},[264,419,420],{},[219,421,422],{},"POST \u002Fv1\u002Fruns\u002F{id}\u002Fskip",[264,424,425],{},"Skip with policy permission and a reason",[249,427,428,433],{},[264,429,430],{},[219,431,432],{},"POST \u002Fv1\u002Fruns\u002F{id}\u002Fcancel",[264,434,435],{},"Request cancellation",[211,437,439],{"id":438},"integrate-external-triggers","Integrate external triggers",[200,441,442],{},"Pyplines has no built-in scheduler or webhook receiver. An external scheduler or incident system can authenticate, start a Run, and observe its ID. Persist the Run ID and request key before retrying an uncertain response. A new key can create new work; a polling timeout does not cancel existing work.",[200,444,445,446,449,450,449,453,456,457,460,461,209],{},"Decide explicitly how your integration handles ",[219,447,448],{},"awaiting_approval",", ",[219,451,452],{},"blocked",[219,454,455],{},"uncertain",", and ",[219,458,459],{},"cancelling",". Do not equate request acceptance with successful completion. See ",[207,462,463],{"href":88},"Run states",[200,465,466,467,470,471,474],{},"The Python distribution ",[219,468,469],{},"pyplines[client]"," provides the API client used by the operator CLI. Choose it from the supported tooling release. The ",[207,472,473],{"href":180},"SDK reference"," primarily covers authoring Actions; Action handlers are not required for API integration.",{"title":476,"searchDepth":477,"depth":477,"links":478},"",2,[479,480,481],{"id":213,"depth":477,"text":214},{"id":240,"depth":477,"text":241},{"id":438,"depth":477,"text":439},"Use the same API as the operator CLI for external automation.","md",{},true,{"title":171,"description":482},"Hr_ZBchM6QzQAbhfkB6e5T0NCV4A_mBBsa4spSEXfps",[489,491],{"title":167,"path":168,"stem":169,"description":490,"children":-1},"Server selection, TLS trust, sessions, and noninteractive clients.",{"title":175,"path":176,"stem":177,"description":492,"children":-1},"Commands for authoring and publishing typed Actions.",1792213697805]