Skip to content
Vellum

Workspaces endpoints

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

GET /api/workspaces

Section titled “GET /api/workspaces”
Status Meaning Body
200 OK none

POST /api/workspaces

Section titled “POST /api/workspaces”

Request body (application/json): CreateWorkspaceRequest

Field Type Required Notes
id string (uuid) yes
name string yes
Status Meaning Body
200 OK none

PATCH /api/workspaces/{id}

Section titled “PATCH /api/workspaces/{id}”
Parameter In Type Required
id path string (uuid) yes

Request body (application/json): UpdateWorkspaceRequest

Field Type Required Notes
name string or null yes
Status Meaning Body
200 OK none

DELETE /api/workspaces/{id}

Section titled “DELETE /api/workspaces/{id}”
Parameter In Type Required
id path string (uuid) yes
Status Meaning Body
200 OK none