Create

POST
/workspaces
/:domain
/projects
/:project_name
/repository
/branches

Creates a new branch in the project repository.

Request

REQUIRED SCOPES

WORKSPACE, REPOSITORY_WRITE

URL PARAMETERS

domainrequired string

The workspace domain.

project_namerequired string

The name ID of the project.

POST PARAMETERS

commitCommit

The commit containing the revision field. Based on this commit a new branch will be created.

descriptionstring

The description of the branch.

namestring

The unique name of the branch.

Last modified on Sep 27, 2024

Get details and logs Get

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/repository/branches" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "name": "dev",
  "description": "development branch",
  "commit": {
    "revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/branches/dev",
  "html_url": "https://app.buddy.works/buddy/company-website/repository/branch/dev",
  "name": "dev",
  "commit": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/commits/506a3963507943d6908154f4bc9646e829128a08",
    "html_url": "https://app.buddy.works/buddy/company-website/repository/commit/506a3963507943d6908154f4bc9646e829128a08",
    "revision": "506a3963507943d6908154f4bc9646e829128a08",
    "author_date": "2016-01-19T12:36:33Z",
    "commit_date": "2016-01-19T12:36:33Z",
    "message": "init repo\n",
    "committer": {
      "url": "https://api.buddy.works/workspaces/buddy/member/1",
      "html_url": "https://app.buddy.works/buddy/profile/1",
      "id": 1,
      "name": "Mike Benson",
      "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png"
    },
    "author": {
      "url": "https://api.buddy.works/workspaces/buddy/member/1",
      "html_url": "https://app.buddy.works/buddy/profile/1",
      "id": 1,
      "name": "Mike Benson",
      "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png"
    }
  },
  "description": "development branch",
  "default": false
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999