Skip to main content
PATCH
/
api
/
v1
/
commit_tags
/
{tag_name}
cURL
curl --request PATCH \
  --url https://api.example.com/api/v1/commit_tags/{tag_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>"
}
'
{
  "error": "<string>",
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tag_name
string
required

The name of the tag to update

Body

application/json

Request body for PATCH /api/v1/commit_tags/{tag_name}

For description:

  • Field absent from JSON → don't change the description
  • Field present as null → clear the description
  • Field present as "text" → set the description to "text"
​
commit_id
string<uuid> | null

Optional new commit ID to move the tag to

​
description
string | null

Optional new description for the tag. Send null to clear an existing description.

Response

Tag updated successfully