Update a branch

Updates branch properties including:

• Name
• Description
• The commit it points to
• Protection status and configuration

Parameters: The following optional fields can be provided in the request body:

• branch_name
• branch_description
• commit_id
• is_protected - Whether the branch is protected (requires ADMIN access)
• protection_config - Configuration for protected branches (requires ADMIN access)

Limitations:

• Renaming branches is not supported for repositories synced with Git.
• Setting protection requires ADMIN access to the repository.

Returns:

• 409 Conflict if a branch with the new name already exists
• 403 Forbidden if attempting to modify protection without ADMIN access
• 204 No Content on success

PATCH /repos/{repo_id}/branches/{branch_id}

Update a branch

cURL

curl --request PATCH \
  --url https://api.diversion.dev/v0/repos/{repo_id}/branches/{branch_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commit_id": "<string>",
  "branch_name": "<string>",
  "branch_description": "<string>"
}
'

409

{
  "status": 403,
  "detail": "User not authorized to perform the requested action on the resource",
  "title": "<string>",
  "type": "<string>"
}

Authorizations

Authorization · string · header · required

This API uses OAuth 2 with the implicit grant flow

Path Parameters

repo_id · string · required

The repo ID of the repository. Repo name can be used instead of the ID, but usage of ID for permanent linking and API requests is preferred.

Required string length: 3 - 128

Example:

"example_id"

branch_id · string · required

Branch ID. Branch name can be used instead of the ID, but storing and using branch ID in API requests is preferred.

Required string length: 3 - 128

Example:

"example_id"

Body

application/json

commit_id · string

branch_name · string

branch_description · string

Response

204

Request completed successfully