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)curl --request POST \
--url https://api.13-215-85-171.sslip.io/v1/templates/refs/{ref}/rename \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"new_name": "<string>"
}
'{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"builtin": true,
"canonical_ref": "<string>",
"namespace_slug": "<string>",
"visibility": "private",
"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
}
}
}{
"error": "<string>",
"code": "invalid_request",
"error_detail": {
"code": "unauthorized",
"message": "<string>",
"phase": "auth",
"retryable": true,
"suggested_action": "<string>",
"step_index": 123,
"attempt": 123,
"max_attempts": 123,
"cache_subject": "<string>",
"build_id": "<string>",
"request_id": "<string>",
"details": {}
},
"request_id": "<string>",
"build_id": "<string>"
}{
"error": "<string>",
"code": "invalid_request",
"error_detail": {
"code": "unauthorized",
"message": "<string>",
"phase": "auth",
"retryable": true,
"suggested_action": "<string>",
"step_index": 123,
"attempt": 123,
"max_attempts": 123,
"cache_subject": "<string>",
"build_id": "<string>",
"request_id": "<string>",
"details": {}
},
"request_id": "<string>",
"build_id": "<string>"
}{
"error": "<string>",
"code": "invalid_request",
"error_detail": {
"code": "unauthorized",
"message": "<string>",
"phase": "auth",
"retryable": true,
"suggested_action": "<string>",
"step_index": 123,
"attempt": 123,
"max_attempts": 123,
"cache_subject": "<string>",
"build_id": "<string>",
"request_id": "<string>",
"details": {}
},
"request_id": "<string>",
"build_id": "<string>"
}{
"error": "<string>",
"code": "invalid_request",
"error_detail": {
"code": "unauthorized",
"message": "<string>",
"phase": "auth",
"retryable": true,
"suggested_action": "<string>",
"step_index": 123,
"attempt": 123,
"max_attempts": 123,
"cache_subject": "<string>",
"build_id": "<string>",
"request_id": "<string>",
"details": {}
},
"request_id": "<string>",
"build_id": "<string>"
}Templates
Rename a logical template by canonical ref
Firecracker-only endpoint. If the template’s canonical ref itself ends with rename, the subresource remains one segment deeper, for example /v1/templates/refs/acme/rename/rename. Renames the logical template and preserves the old canonical name as a read-only alias.
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)curl --request POST \
--url https://api.13-215-85-171.sslip.io/v1/templates/refs/{ref}/rename \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"new_name": "<string>"
}
'{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"builtin": true,
"canonical_ref": "<string>",
"namespace_slug": "<string>",
"visibility": "private",
"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
}
}
}{
"error": "<string>",
"code": "invalid_request",
"error_detail": {
"code": "unauthorized",
"message": "<string>",
"phase": "auth",
"retryable": true,
"suggested_action": "<string>",
"step_index": 123,
"attempt": 123,
"max_attempts": 123,
"cache_subject": "<string>",
"build_id": "<string>",
"request_id": "<string>",
"details": {}
},
"request_id": "<string>",
"build_id": "<string>"
}{
"error": "<string>",
"code": "invalid_request",
"error_detail": {
"code": "unauthorized",
"message": "<string>",
"phase": "auth",
"retryable": true,
"suggested_action": "<string>",
"step_index": 123,
"attempt": 123,
"max_attempts": 123,
"cache_subject": "<string>",
"build_id": "<string>",
"request_id": "<string>",
"details": {}
},
"request_id": "<string>",
"build_id": "<string>"
}{
"error": "<string>",
"code": "invalid_request",
"error_detail": {
"code": "unauthorized",
"message": "<string>",
"phase": "auth",
"retryable": true,
"suggested_action": "<string>",
"step_index": 123,
"attempt": 123,
"max_attempts": 123,
"cache_subject": "<string>",
"build_id": "<string>",
"request_id": "<string>",
"details": {}
},
"request_id": "<string>",
"build_id": "<string>"
}{
"error": "<string>",
"code": "invalid_request",
"error_detail": {
"code": "unauthorized",
"message": "<string>",
"phase": "auth",
"retryable": true,
"suggested_action": "<string>",
"step_index": 123,
"attempt": 123,
"max_attempts": 123,
"cache_subject": "<string>",
"build_id": "<string>",
"request_id": "<string>",
"details": {}
},
"request_id": "<string>",
"build_id": "<string>"
}Authorizations
API key passed as Bearer token
Path Parameters
Canonical custom template ref.
Body
application/json
New single-segment logical template name
Response
Updated template metadata
Available options:
private, public Effective runtime defaults retained for a built template. Environment values are intentionally omitted; only keys are exposed.
Show child attributes
Show child attributes