Bindings 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}/bindings

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	PageOfBindingDto

POST /api/projects/{projectId}/bindings

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

Request body (application/json): AddBindingRequest

Field	Type	Required	Notes
id	string (uuid)	yes
sourceChannelId	string (uuid)	yes
targetChannelId	string (uuid)	yes
routingKey	string or null	yes

Status	Meaning	Body
201	Created	BindingDto

PATCH /api/projects/{projectId}/bindings/{bindingId}

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

Request body (application/json): UpdateBindingRequest

Field	Type	Required	Notes
sourceChannelId	string (uuid) or null	yes
targetChannelId	string (uuid) or null	yes
routingKey	string or null	yes
setRoutingKey	boolean	no	default false
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

Status	Meaning	Body
200	OK	BindingDto

DELETE /api/projects/{projectId}/bindings/{bindingId}

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

Status	Meaning	Body
204	No Content	none