What is a template name?
A name is a string identifier that you assign to a template when building it. Once a template is built with a name, you can use that name to create sandboxes from the template.Name format
Before a name is used, it’s trimmed of surrounding whitespace and lowercased. The result must match the pattern^[a-z0-9-_]+$:
- Lowercase letters (
a–z), numbers (0–9), dashes (-), and underscores (_) - Between 1 and 128 characters
- Leading and trailing dashes or underscores are allowed
My-Template and my-template refer to the same name. Any other character (spaces inside the name, dots, slashes, and so on) is rejected.
Team-local naming
Template names are scoped to your team. This means:- Your template named
my-appis stored asyour-team-slug/my-app - You can reference it simply as
my-appwithin your team - Other teams can have their own
my-apptemplate without conflict - Public templates should be referenced using the full namespaced format (
team-slug/template-name)
Backwards Compatibility: Existing public templates remain accessible without the team slug prefix. New public templates should be referenced using the full namespaced format (
team-slug/template-name).Common use cases
Development and production environments
Use different names for different environments:Multiple template variants
Create different variants of the same template with different configurations:Checking name availability
You can check if a name is already in use within your team with theexists method.
Best practices
- Use descriptive names: Choose names that clearly indicate the template’s purpose or configuration
- Use tags for versioning: Instead of baking version numbers into names, use tags for version management (e.g.,
myapp:v1,myapp:v2) - Use consistent naming: Establish a naming convention for your team and stick to it