Settings 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/{workspaceId}/settings

Parameter	In	Type	Required
workspaceId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	WorkspaceSettingsResponse

PUT /api/workspaces/{workspaceId}/settings

Parameter	In	Type	Required
workspaceId	path	string (uuid)	yes

Request body (application/json): JsonElement

Status	Meaning	Body
200	OK	WorkspaceSettingsResponse
400	Bad Request	ErrorResponse
409	Conflict	ErrorResponse
413	Payload Too Large	ErrorResponse
428	Precondition Required	ErrorResponse

GET /api/workspaces/{workspaceId}/secrets

Parameter	In	Type	Required
workspaceId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	array of SecretStatusDto

PUT /api/workspaces/{workspaceId}/secrets/{name}

Parameter	In	Type	Required
workspaceId	path	string (uuid)	yes
name	path	string	yes

Request body (application/json): SetSecretRequest

Field	Type	Required	Notes
value	string or null	yes

Status	Meaning	Body
204	No Content	none
400	Bad Request	ErrorResponse
413	Payload Too Large	ErrorResponse

DELETE /api/workspaces/{workspaceId}/secrets/{name}

Parameter	In	Type	Required
workspaceId	path	string (uuid)	yes
name	path	string	yes

Status	Meaning	Body
204	No Content	none
400	Bad Request	ErrorResponse

GET /api/workspaces/{workspaceId}/audit

Parameter	In	Type	Required
workspaceId	path	string (uuid)	yes
limit	query	integer (int32) or string (int32)	no

Status	Meaning	Body
200	OK	array of AuditEntryDto