Edit project

Only the workspace administrator can edit the project.

Required scopes: WORKSPACE

Resource URL

PATCH /workspaces/:domain/projects/:project_name

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
project_name
Required
StringThe name ID of the project.

POST Parameters

NameTypeDescription
display_nameStringThe full name of the project.
nameStringThe name ID of the project (must be unique in the workspace).

Example

Request

PATCH https://api.buddy.works/workspaces/buddy/projects/company-website

JSON

{
  "display_name": "Company Website"
}

Sample Response

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website",
  "html_url": "https://app.buddy.works/buddy/company-website",
  "name": "company-website",
  "display_name": "Company Website",
  "status": "ACTIVE",
  "create_date": "2016-02-29T11:23:04Z",
  "created_by": {
    "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",
    "title": "Creative director"
  },
  "http_repository": "https://app.buddy.works/buddy/company-website",
  "ssh_repository": "buddy@app.buddy.works:buddy/company-website",
  "size": 1908,
  "default_branch": "master"
}
Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.