Get deployment template

View as Markdown

Generates a deployment spec template for the agent. Returns YAML by default; pass format=json for JSON. Optionally pin to a specific build with ?build=<build_id>.

Authentication

AuthorizationBearer
OAuth 2.0 device flow or session token from WorkOS

Path parameters

accountstringRequired

Account name (slug)

namestringRequired
Agent name

Query parameters

buildstringOptional

Specific build ID to use (defaults to latest)

formatenumOptional

Response format (json or yaml, default yaml)

Allowed values:

Response

Deployment spec template

Errors