Skip to content
Vellum

Sharing endpoints

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

Section titled “GET /api/projects/{projectId}/share-links”
Parameter In Type Required
projectId path string (uuid) yes
Status Meaning Body
200 OK array of ShareLinkDto

POST /api/projects/{projectId}/share-links

Section titled “POST /api/projects/{projectId}/share-links”
Parameter In Type Required
projectId path string (uuid) yes

Request body (application/json): CreateShareLinkRequest

Field Type Required Notes
scope string yes
viewId string (uuid) or null yes
mode string yes
revisionId string (uuid) or null yes
label string or null yes
showCosts boolean yes
showPromises boolean yes
password string or null yes
expiresAt string (date-time) or null yes
Status Meaning Body
201 Created ShareLinkCreatedDto
400 Bad Request ErrorResponse
409 Conflict ErrorResponse

PATCH /api/projects/{projectId}/share-links/{linkId}

Section titled “PATCH /api/projects/{projectId}/share-links/{linkId}”
Parameter In Type Required
projectId path string (uuid) yes
linkId path string (uuid) yes

Request body (application/json): ChangeShareLinkRequest

Field Type Required Notes
label string or null yes
showCosts boolean or null yes
showPromises boolean or null yes
password string or null yes
removePassword boolean yes
expiresAt string (date-time) or null yes
clearExpiry boolean yes
Status Meaning Body
200 OK ShareLinkDto
400 Bad Request ErrorResponse
403 Forbidden ErrorResponse
404 Not Found ErrorResponse
409 Conflict ErrorResponse

POST /api/projects/{projectId}/share-links/{linkId}/revoke

Section titled “POST /api/projects/{projectId}/share-links/{linkId}/revoke”
Parameter In Type Required
projectId path string (uuid) yes
linkId path string (uuid) yes
Status Meaning Body
204 No Content none
403 Forbidden ErrorResponse
404 Not Found ErrorResponse