Skip to content

Document workspace name restrictions #12047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
mdanish-kh opened this issue Feb 7, 2024 · 5 comments · Fixed by #17312
Closed

Document workspace name restrictions #12047

mdanish-kh opened this issue Feb 7, 2024 · 5 comments · Fixed by #17312
Labels
docs Area: coder.com/docs

Comments

@mdanish-kh
Copy link
Contributor

mdanish-kh commented Feb 7, 2024 •
edited by matifali
Loading

  • Workspace name must start with a-Z or 0-9 and can contain a-Z, 0-9 or -
  • The workspace name seems to have a limit of 32 characters.
  • They also don't seem to accept special characters / whitespaces.
  • Duplicate workspace names are not allowed

One can easily miss this when creating workspaces through API. Requesting an update at https://coder.com/docs/api/schemas#properties-69
@cdr-bot cdr-bot bot added the docs Area: coder.com/docs label Feb 7, 2024
@matifali
Copy link
Member

matifali commented Feb 7, 2024

Duplicate workspace names are not allowed

This is only for a single user. Two different users can have workspaces with same name.

@kylecarbs kylecarbs changed the title Docs: document workspace name restrictions Document workspace name restrictions Feb 7, 2024
@matifali
Copy link
Member

matifali commented Aug 5, 2024

@stirby, any suggestions on where we can document this? This can be added as a note in API reference docs.

@strike
Copy link
Contributor

strike commented Feb 3, 2025

And

Image

workspace name can't end with '-'.

@stirby
Copy link
Collaborator

stirby commented Feb 4, 2025

I believe this should be included in the API reference docs and maybe a note under:

https://coder.com/docs/user-guides/workspace-management#creating-workspaces

@EdwardAngert EdwardAngert mentioned this issue Apr 9, 2025
Merged
@EdwardAngert
Copy link
Contributor

PR! #17312

EdwardAngert added a commit that referenced this issue Apr 15, 2025
@EdwardAngert
docs: document workspace naming rules and restrictions (#17312)
0cd531d 
closes #12047 


[preview](https://coder.com/docs/@12047-workspace-names/user-guides/workspace-management)

---------

Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Area: coder.com/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: document workspace naming rules and restrictions coder/coder
5 participants
@strike @matifali @EdwardAngert @stirby @mdanish-kh