Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Project API

Get a specific project by name

get/workspaces/{workspace_domain}/projects/{project_name}

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

project_namestring required
Example:my-project

The human-readable ID of the project

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

namestring

The human-readable ID of the project

display_namestring required

The Name of the project

statusstring

The status of the project

access'PRIVATE' | 'PUBLIC'

Indicates if this is a public project

create_datestring date-time

The creation date of the project

external_project_idstring

Repo slug of the Bitbucket, GitHub or GitLab project. Required when adding the integrated project

git_lab_project_idinteger

ID of the project in GitLab

custom_repo_urlstring

SSH or HTTPS url of the git repository. Required when adding the project integrated with custom git repository

custom_repo_userstring

Username used to authorize access to the git repository. Required when adding the project integrated with custom git repository

custom_repo_passstring

Password used to authorize access to the git repository. Required when adding the project integrated with custom git repository and the provided custom_repo_url is the HTTPS url

custom_repo_ssh_key_idinteger

The ID of the private SSH key used to authorize access to the git repository. Required when adding the project integrated with private git server by SSH url

http_repositorystring

The HTTP repository URL

ssh_repositorystring

The SSH repository URL

default_branchstring

The default branch name

fetch_submodulesboolean

Defines whether the submodules are fetched during the runs in this project

fetch_submodules_env_keystring

Name of the key that will be used to authorize while fetching the submodules. Required when fetch_submodules is set to true

allow_pull_requestsboolean

Enables/disables pull requests in the project. Available only for projects synchronized with GitHub or GitHub Enterprise repository

update_default_branch_from_externalboolean

If set to true, the default branch will be updated from GitHub/GitLab/Bitbucket.

without_repositoryboolean

If set to true, the project is created without any repository attached.

Example response

{
  "name": "my-project",
  "display_name": "My Project"
}