Deployments

Update Deployment Release Tag

Beta
PATCH
Updates an existing Release Tag associated with the specified Deployment.

Path parameters

idstringRequired
A UUID string identifying this deployment.
namestringRequired
The name of the Release Tag associated with this Deployment that you'd like to update.

Request

This endpoint expects an object.
history_item_id
stringOptional
The ID of the Deployment History Item to tag

Response

This endpoint returns an object
name
string
The name of the Release Tag
source
enum

The source of how the Release Tag was originally created

  • SYSTEM - System
  • USER - User
Allowed values: SYSTEMUSER
history_item
object
The Deployment History Item that this Release Tag is associated with
PATCH
1curl -X PATCH https://api.vellum.ai/v1/deployments/id/release-tags/name \
2 -H "X_API_KEY: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Updated
1{
2 "name": "name",
3 "source": "SYSTEM",
4 "history_item": {
5 "id": "id",
6 "timestamp": "2024-01-15T09:30:00Z"
7 }
8}