Bitbucket Cloud
App Vendor: Atlassian
App Category: IT Services
Connector Version: 1.0.1
API Version: v2.0.0
About App
Bitbucket Cloud offers developers with private or public spaces to build, test, and deploy codes.
The Bitbucket Cloud app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Generic Action | This is a generic action to perform any additional use case on Bitbucket Cloud. |
Get Branch Restrictions | This action retrieves branch restrictions of a specific repository. |
Get Commit Statuses | This action retrieves commit statuses. |
Get Commits | This action retrieves the details of the commits. |
Get Pull Requests | This action retrieves all the pull requests of a specific repository. |
Get Repository Details | This action retrieves the details of a specific repository. |
List All Repositories | This action retrieves all repositories in a specific workspace. |
Configuration Parameters
The following configuration parameters are required for the Bitbucket Cloud app to communicate with the Bitbucket Cloud enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Username | Enter the username to authenticate. | Text | Required | |
App password | Enter the app password to authenticate. | Password | Required |
Action: Generic Action
This is a generic action to perform any additional use case on Bitbucket Cloud.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Method | Enter the HTTP method to use. Example:
| Text | Required |
|
Endpoint | Enter the bitbucket endpoint. Example: "repositories/{workspace}/{repo_slug}/pullrequests" | Text | Required |
|
Payload | Enter the payload to send with the request. Example: {"title": "Pull requests"} | Any | Optional |
|
Query Params | Enter the query parameters to send with the request. Example: {"pagelen": 100} | Key Value | Optional |
|
Example Request
[
{
"method": "PUT",
"endpoint": "repositories/{workspace}/{repo_slug}/pullrequests",
"payload": {"title": "Pull requests"},
"query_params": {"pagelen": 100}
}
]Action: Get Branch Restrictions
This action retrieves branch restrictions of a specific repository.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Full Name of Repository | Enter the full name of the repository. Example: "dev/orchid" | Text | Required |
|
Page Length | Enter the number of objects to retrieve per page. Example: 10 | Integer | Optional | Maximum allowed value: 100 Default value: 10 |
Page Number | Enter the page number to retrieve the objects. Example: 1 | Integer | Optional |
|
Example Request
[
{
"full_name_of_repository": "dev/orchid",
"page_length": 10,
"page_number": 1
}
]Action: Get Commit Statuses
This action retrieves commit statuses.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Full Name of Repo | Enter the full name of the repository. Example: "dev/orchid" | Text | Required |
|
Commit ID | Enter the commit ID to retrieve the details. Example: "65a3a6d" | Text | Required | You can retrieve the commit ID using the Get Commits action. |
Page Length | Enter the number of objects to retrieve per page. Example: 10 | Integer | Optional | Maximum allowed value: 100 Default value: 10 |
Example Request
[
{
"full_name_of_repository": "dev/orchid",
"commit_id": "65a3a6d",
"page_length": 10
}
]Action: Get Commits
This action retrieves the details of the commits.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Full Name of Repo | Enter the full name of the repository. Example: "dev/orchid" | Text | Required |
|
Extra params | Enter the extra parameters. | Key Value | Optional |
|
Example Request
[
{
"full_name_of_repository": "dev/orchid"
}
]Action: Get Pull Requests
This action retrieves all the pull requests of a specific repository.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Full Name of Repository | Enter the full name of the repository. Example: "dev/orchid" | Text | Required |
|
Page Length | Enter the number of objects to retrieve per page. Example: 10 | Integer | Optional | Maximum allowed value: 100 Default value: 10 |
Page Number | Enter the page number to retrieve the objects. Example: 1 | Integer | Optional |
|
Query | Enter the query parameters to filter the pull requests. Example: "updated_on > 2023-01-14" | Text | Optional |
|
State | The state of the pull request. Example: "OPEN" | Text | Optional | Allowed values:
|
Example Request
[
{
"full_name_of_repository": "dev/orchid",
"page_length": 10,
"page_number": 1,
"query": "updated_on > 2023-01-14",
"state": "OPEN"
}
]Action: Get Repository Details
This action retrieves the details of a specific repository.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Full Name of Repository | Enter the full name of the repository. Example: "dev/orchid" | Text | Required |
|
Example Request
[
{
"full_name_of_repository": "dev/orchid"
}
]Action: List All Repositories
This action retrieves all repositories in a specific workspace.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Workspace Name | Enter the workspace ID (slug) or the workspace UUID within curly braces. Example: "cywarelabs" | Text | Required |
|
Page Length | Enter the number of objects to retrieve per page. Example: 10 | Integer | Optional | Maximum allowed value: 100 Default value: 10 |
Page Number | Enter the page number to retrieve the objects. Example: 1 | Integer | Optional |
|
Example Request
[
{
"workspace_name": "cywarelabs",
"page_length": 10,
"page_number": 1
}
]