Skip to main content
Use this endpoint to create a new workspace under your Virtus Cloud account. Workspaces let you group applications together and collaborate with other users by managing membership and permissions. The authenticated user becomes the workspace owner automatically.

Request

POST https://api.virtuscloud.app/v2/workspaces

Headers

Authorization
string
required
Your Virtus Cloud API key. Pass it directly as the header value — no prefix required.Example: Authorization: vc_live_xxxxxxxxxxxx

Body

name
string
required
The display name for the workspace. Must be between 3 and 32 characters and match the pattern [a-zA-Z0-9_] — alphanumeric characters and underscores only.

Response

status
string
Returns "success" when the workspace is created successfully.
response
object
The newly created workspace object.

Examples

curl -X POST https://api.virtuscloud.app/v2/workspaces \
  -H "Authorization: <api_key>" \
  -H "Content-Type: application/json" \
  -d '{"name": "Test"}'

Response Example

{
  "status": "success",
  "response": {
    "id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
    "owner": "5354d9742d889d49b20134ba0be09ccc0033be68",
    "name": "Test",
    "createdAt": "2025-06-04T20:44:55.934Z"
  }
}