Subscriptions endpoints

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

GET /api/projects/{projectId}/subscriptions

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

Status	Meaning	Body
200	OK	PageOfSubscriptionDto

POST /api/projects/{projectId}/subscriptions

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
branchId	query	string (uuid)	no

Request body (application/json): AddSubscriptionRequest

Field	Type	Required	Notes
id	string (uuid)	yes
channelId	string (uuid)	yes
consumerId	string (uuid)	yes
retry	null or RetryDto	yes
deadLetterChannelId	string (uuid) or null	yes

Status	Meaning	Body
201	Created	SubscriptionDto

PATCH /api/projects/{projectId}/subscriptions/{subscriptionId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
subscriptionId	path	string (uuid)	yes
branchId	query	string (uuid)	no

Request body (application/json): UpdateSubscriptionRequest

Field	Type	Required	Notes
channelId	string (uuid) or null	yes
consumerId	string (uuid) or null	yes
retry	null or RetryDto	yes
deadLetterChannelId	string (uuid) or null	yes
setDeadLetterChannelId	boolean	no	default false
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

Status	Meaning	Body
200	OK	SubscriptionDto

DELETE /api/projects/{projectId}/subscriptions/{subscriptionId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
subscriptionId	path	string (uuid)	yes
branchId	query	string (uuid)	no

Status	Meaning	Body
204	No Content	none