Projects

Creates a new project.

Note that the avatar has to be embedded as either a data-url or a URL to an external image as shown in the examples below:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
$ body=$(cat << EOF
{
    "name": "Mars Project",
    "key": "MARS",
    "description": "Software for colonizing mars.",
    "links": {
        "avatar": {
            "href": "data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/..."
        }
    },
    "is_private": false
}
EOF
)
$ curl -H "Content-Type: application/json" \
       -X POST \
       -d "$body" \
       https://api.bitbucket.org/2.0/workspaces/teams-in-space/projects/ | jq .
{
  // Serialized project document
}

or even:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
$ body=$(cat << EOF
{
    "name": "Mars Project",
    "key": "MARS",
    "description": "Software for colonizing mars.",
    "links": {
        "avatar": {
            "href": "http://i.imgur.com/72tRx4w.gif"
        }
    },
    "is_private": false
}
EOF
)
$ curl -H "Content-Type: application/json" \
       -X POST \
       -d "$body" \
       https://api.bitbucket.org/2.0/workspaces/teams-in-space/projects/ | jq .
{
  // Serialized project document
}

Scopes

Request

allOf [object, Project]

Responses

Returns the requested project.

Scopes

Request

Responses

Since this endpoint can be used to both update and to create a project, the request body depends on the intent.

Creation

See the POST documentation for the project collection for an example of the request body.

Note: The key should not be specified in the body of request (since it is already present in the URL). The name is required, everything else is optional.

Update

See the POST documentation for the project collection for an example of the request body.

Note: The key is not required in the body (since it is already in the URL). The key may be specified in the body, if the intent is to change the key itself. In such a scenario, the location of the project is changed and is returned in the Location header of the response.

Scopes

Request

allOf [object, Project]

Responses

Deletes this project. This is an irreversible operation.

You cannot delete a project that still contains repositories. To delete the project, delete or transfer the repositories first.

Example:

1
$ curl -X DELETE https://api.bitbucket.org/2.0/workspaces/bbworkspace1/projects/PROJ

Scopes

Request

Responses

Return a list of all default reviewers for a project. This is a list of users that will be added as default reviewers to pull requests for any repository within the project.

Scopes

Request

Responses

Returns the specified default reviewer.

Scopes

Request

Responses

Adds the specified user to the project's list of default reviewers. The method is idempotent. Accepts an optional body containing the uuid of the user to be added.

Scopes

Request

Responses

Removes a default reviewer from the project.

Example:

1
2
3
$ curl https://api.bitbucket.org/2.0/.../default-reviewers/%7Bf0e0e8e9-66c1-4b85-a784-44a9eb9ef1a6%7D

HTTP/1.1 204

Scopes

Request

Responses

Returns a paginated list of explicit group permissions for the given project. This endpoint does not support BBQL features.

Scopes

Request

Responses

Returns the group permission for a given group and project.

Only users with admin permission for the project may access this resource.

Permissions can be:

• admin
• create-repo
• write
• read
• none

Scopes

Request

Responses

Updates the group permission, or grants a new permission if one does not already exist.

Only users with admin permission for the project may access this resource.

Due to security concerns, the JWT and OAuth authentication methods are unsupported. This is to ensure integrations and add-ons are not allowed to change permissions.

Permissions can be:

• admin
• create-repo
• write
• read

Request

The permission to grant

Responses

Deletes the project group permission between the requested project and group, if one exists. Only users with admin permission for the project may access this resource.

Request

Responses

Returns a paginated list of explicit user permissions for the given project. This endpoint does not support BBQL features.

Scopes

Request

Responses

Returns the explicit user permission for a given user and project.

Only users with admin permission for the project may access this resource.

Permissions can be:

• admin
• create-repo
• write
• read
• none

Scopes

Request

Responses

Updates the explicit user permission for a given user and project. The selected user must be a member of the workspace, and cannot be the workspace owner.

Only users with admin permission for the project may access this resource.

Due to security concerns, the JWT and OAuth authentication methods are unsupported. This is to ensure integrations and add-ons are not allowed to change permissions.

Permissions can be:

• admin
• create-repo
• write
• read

Request

The permission to grant

Responses

Deletes the project user permission between the requested project and user, if one exists.

Only users with admin permission for the project may access this resource.

Due to security concerns, the JWT and OAuth authentication methods are unsupported. This is to ensure integrations and add-ons are not allowed to change permissions.

Request

Responses