Skip to main content
POST
/
v1
/
templates
/
refs
/
{ref}
/
rename
Rename a logical template by canonical ref
import requests

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

payload = { "new_name": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, 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 custom template ref.

Body

application/json
new_name
string
required

New single-segment logical template name

Response

Updated template metadata

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.