Workspaces
Create workspace
Create a new workspace to organize computers.
POST
Create workspace
Creates a workspace and returns it with
Creating a workspace needs an account-wide API key. A workspace-scoped key gets
The create response does not include
201. The calling account becomes the owner.
Workspaces are containers for computers. Use them to separate projects, environments, or teams.
403. See Authentication.
An account can own up to 9999 workspaces, on every plan. Client accounts and workspaces you are a member of do not count. New workspaces are also rate limited by the plan of the account that will own them, as described in Plan rate limits.
Request
Workspace name, 80 characters at most after trimming. Leading and trailing whitespace is trimmed. The name must not match one you already own, compared case-insensitively. Names of workspaces shared with you do not conflict. Missing, non-string, whitespace-only, or longer values are rejected with
400. The name bops, in any letter case, belongs to the Bops app: it makes a Bops workspace (product bops), or answers 200 with the one the Bops app already made.Optional URL of an icon for the workspace. Stored as given and not validated. Omit it and the workspace is created with
icon_url: null.Optional. Defaults to
active when omitted. The product understands active and inactive. The field is stored as given and is not validated against that list.Response
Which product the workspace belongs to:
orgo for a workspace you create here. A workspace the Bops app makes is bops.updated_at, owner_tier, owner_email, or desktops. Get workspace returns those.
Example
Response
Errors
Some error bodies on this endpoint carry a
code alongside error. Branch on code where it is present. It is stable, and the error string is not.Authorizations
Body
application/json
Response
A name of bops (any letter case), sent with no product, when the Bops app already made your first Bops workspace: that workspace, and nothing is created.