Get template details by canonical ref

import requests

url = "https://api.13-215-85-171.sslip.io/v1/templates/refs/{ref}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "builtin": true,
  "canonical_ref": "<string>",
  "namespace_slug": "<string>",
  "tags": [
    "<string>"
  ],
  "default_tag": "<string>",
  "runtime_defaults": {
    "default_env_keys": [
      "<string>"
    ],
    "start_cmd": "<string>",
    "default_user": "<string>",
    "default_workdir": "<string>",
    "readiness": {
      "kind": "tcp",
      "port": 3000,
      "timeout_secs": 30,
      "interval_ms": 500,
      "startup_grace_secs": 2
    }
  }
}

Templates

Get template details by canonical ref

Firecracker-only endpoint. Accepts raw custom template IDs, logical refs like name and name:tag, exact build refs like name:tb_123, builtin refs like nullspace/base:latest, slug namespaced custom refs like acme/python-dev:stable, and legacy authenticated owner UUID namespaced refs. Full canonical refs take precedence over subresource parsing, so names such as acme/tags, acme/aliases, acme/rename, and acme/visibility remain addressable through this route when those templates exist.

GET

templates

refs

{ref}

Get template details by canonical ref

import requests

url = "https://api.13-215-85-171.sslip.io/v1/templates/refs/{ref}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "builtin": true,
  "canonical_ref": "<string>",
  "namespace_slug": "<string>",
  "tags": [
    "<string>"
  ],
  "default_tag": "<string>",
  "runtime_defaults": {
    "default_env_keys": [
      "<string>"
    ],
    "start_cmd": "<string>",
    "default_user": "<string>",
    "default_workdir": "<string>",
    "readiness": {
      "kind": "tcp",
      "port": 3000,
      "timeout_secs": 30,
      "interval_ms": 500,
      "startup_grace_secs": 2
    }
  }
}

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

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