Skip to main content
GET
Get template details by canonical ref

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

ref
string
required

Canonical template ref. This route accepts slash-bearing refs such as namespace/name, namespace/name:tag, namespace/name:tb_123, and legacy <user_uuid>/<name>:<tag> aliases.

Query Parameters

fields
string

Comma-separated field mask for template list/get responses. Supported fields: id, name, description, tags, default_tag, builtin, canonical_ref, namespace_slug, visibility.

Response

Template details

id
string
required
name
string
required
description
string
required
builtin
boolean
required
canonical_ref
string
required
namespace_slug
string
required
visibility
enum<string>
required
Available options:
private,
public
tags
string[]
default_tag
string
runtime_defaults
object

Effective runtime defaults retained for a built template. Environment values are intentionally omitted; only keys are exposed.