Edit

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 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).
accessStringDefines whether a project is public or private. Available values: PUBLIC, PRIVATE (set by default).
fetch_submodulesBooleanDefines whether the submodules are fetched during the executions in this project.
fetch_submodules_env_keyStringName of the key that will be used to authorize while fetching the submodules. Required when fetch_submodules is set to true.
allow_pull_requestsBooleanEnables/disables pull requests in the project. Available only for projects synchronized with GitHub or GitHub Enterprise repository.

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"
  },
  "http_repository": "https://app.buddy.works/buddy/company-website",
  "ssh_repository": "buddy@app.buddy.works:buddy/company-website",
  "default_branch": "master",
  "access": "PUBLIC",
  "fetch_submodules": true,
  "fetch_submodules_env_key": "id_workspace",
  "allow_pull_requests": true
}

Get Started

Sign up for free and deploy your project in less than 10 minutes.