PUT /workspaces/{workspace}/projects/{project_key}
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.
Servers
- https://api.bitbucket.org/2.0
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
project_key |
String | Yes |
The project in question. This is the actual |
workspace |
String | Yes |
This can either be the workspace ID (slug) or the workspace UUID
surrounded by curly-braces, for example: |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
The name of the project. |
description |
String | No | |
key |
String | No |
The project's key. |
uuid |
String | No |
The project's immutable id. |
created_on |
String | No | |
type |
String | Yes | |
updated_on |
String | No | |
links |
Object | No | |
links.html |
Object | No |
A link to a resource related to this object. |
links.html.href |
String | No | |
links.html.name |
String | No | |
links.avatar |
Object | No |
A link to a resource related to this object. |
links.avatar.href |
String | No | |
links.avatar.name |
String | No | |
is_private |
Boolean | No |
Indicates whether the project is publicly accessible, or whether it is private to the team and consequently only visible to team members. Note that private projects cannot contain public repositories. |
has_publicly_visible_repos |
Boolean | No |
Indicates whether the project contains publicly visible repositories. Note that private projects cannot contain public repositories. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.