openapi: 3.1.0 info: title: Atlassian Admin Account Lists API description: The Atlassian Admin API provides programmatic access to manage Atlassian organizations, users, domains, policies, and events. It enables administrators to automate organization management tasks, integrate with identity providers, and ensure appropriate access to Atlassian products. version: 1.0.0 contact: name: Atlassian Developer url: https://developer.atlassian.com/cloud/admin/ license: name: Atlassian Developer Terms url: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/ x-logo: url: https://wac-cdn.atlassian.com/assets/img/favicons/atlassian/favicon.png servers: - url: https://api.atlassian.com description: Atlassian Cloud API security: - bearerAuth: [] - oauth2: [] tags: - name: Lists paths: /hook_events/{subject_type}: parameters: - name: subject_type in: path description: A resource or subject type. required: true schema: type: string enum: - repository - workspace get: operationId: getHookEvents tags: - Lists description: 'Returns a paginated list of all valid webhook events for the specified entity. **The team and user webhooks are deprecated, and you should use workspace instead. For more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).** This is public data that does not require any scopes or authentication. NOTE: The example response is a truncated response object for the `workspace` `subject_type`. We return the same structure for the other `subject_type` objects.' summary: Atlassian List Subscribable Webhook Types responses: '200': description: A paginated list of webhook types available to subscribe on. content: application/json: schema: $ref: '#/components/schemas/paginated_hook_events' examples: response: value: page: 1 pagelen: 30 size: 4 values: - category: Repository description: Whenever a repository push occurs event: repo:push label: Push - category: Repository description: Whenever a repository fork occurs event: repo:fork label: Fork - category: Repository description: Whenever a repository import occurs event: repo:imported label: Import - category: Pull Request label: Approved description: When someone has approved a pull request event: pullrequest:approved '404': description: If an invalid `{subject_type}` value was specified. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: [] - basic: [] - api_key: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /pullrequests/{selected_user}: parameters: - name: selected_user in: path description: 'This can either be the username of the pull request author, the author''s UUID surrounded by curly-braces, for example: `{account UUID}`, or the author''s Atlassian ID. ' required: true schema: type: string get: tags: - Lists description: Returns all pull requests authored by the specified user.

By default only open pull requests are returned. This can be controlled
using the `state` query parameter. To retrieve pull requests that are
in one of multiple states, repeat the `state` parameter for each
individual state.

This endpoint also supports filtering and sorting of the results. See
[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details. summary: Atlassian List Pull Requests for User responses: '200': description: All pull requests authored by the specified user. content: application/json: schema: $ref: '#/components/schemas/paginated_pullrequests' examples: paginated-pull-requests: $ref: '#/components/examples/paginated-pull-requests' '404': description: If the specified user does not exist. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: state in: query description: Only return pull requests that are in this state. This parameter can be repeated. schema: type: string enum: - OPEN - MERGED - DECLINED - SUPERSEDED security: - oauth2: - pullrequest - basic: [] - api_key: [] operationId: listPullRequestsForUser x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: Returns all pull requests on the specified repository.

By default only open pull requests are returned. This can be controlled
using the `state` query parameter. To retrieve pull requests that are
in one of multiple states, repeat the `state` parameter for each
individual state.

This endpoint also supports filtering and sorting of the results. See
[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details. summary: Atlassian List Pull Requests responses: '200': description: All pull requests on the specified repository. content: application/json: schema: $ref: '#/components/schemas/paginated_pullrequests' examples: paginated-pull-requests: $ref: '#/components/examples/paginated-pull-requests' '401': description: If the repository is private and the request was not authenticated. '404': description: If the specified repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: state in: query description: Only return pull requests that are in this state. This parameter can be repeated. schema: type: string enum: - OPEN - MERGED - DECLINED - SUPERSEDED security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: listPullRequests x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/activity: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: 'The Atlassian Bitbucket Pull Requests API endpoint `/repositories/{workspace}/{repo_slug}/pullrequests/activity` using the GET method retrieves a comprehensive activity log of all pull requests within a specified repository. This endpoint requires two path parameters: `workspace` (the workspace ID or slug) and `repo_slug` (the repository identifier), and returns a chronological feed of events and activities related to pull requests, including actions such as creation, updates, comments, approvals, merges, and status changes. The response provides developers and teams with visibility into the complete lifecycle and collaboration history of pull requests in their repository, making it useful for auditing, monitoring team activity, generating reports, or building integrations that need to track pull request workflows and interactions over time.' summary: Atlassian List Pull Request Activity Log responses: '200': description: The pull request activity log '401': description: If the repository is private and the request was not authenticated. '404': description: If the specified repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: listPullRequestActivityLog x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity: parameters: - name: pull_request_id in: path description: The id of the pull request. required: true schema: type: integer - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: 'The Atlassian Bitbucket Pull Requests API endpoint `/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity` with the GET method retrieves a comprehensive activity log for a specific pull request within a repository. This endpoint requires three path parameters: the workspace identifier, repository slug, and pull request ID, and returns a chronological list of all activities associated with that pull request, including comments, approvals, status changes, updates, merges, and other interactions performed by users. The activity log provides valuable insight into the collaboration history and lifecycle of the pull request, making it useful for tracking changes, understanding decision-making processes, and maintaining an audit trail of all modifications and discussions that occurred throughout the pull request''s lifetime.' summary: Atlassian List Pull Request Activity Log responses: '200': description: The pull request activity log '401': description: If the repository is private and the request was not authenticated. '404': description: If the specified repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: listPullRequestActivityLog x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments: parameters: - name: pull_request_id in: path description: The id of the pull request. required: true schema: type: integer - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: Returns a paginated list of the pull request's comments.

This includes both global, inline comments and replies.

The default sorting is oldest to newest and can be overridden with
the `sort` query parameter.

This endpoint also supports filtering and sorting of the results. See
[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more
details. summary: Atlassian List Comments on Pull Request responses: '200': description: A paginated list of comments made on the given pull request, in chronological order. content: application/json: schema: $ref: '#/components/schemas/paginated_pullrequest_comments' examples: paginated-pull-request-comments: $ref: '#/components/examples/paginated-pull-request-comments' '403': description: If the authenticated user does not have access to the pull request. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the pull request does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: listCommentsOnPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commits: parameters: - name: pull_request_id in: path description: The id of the pull request. required: true schema: type: integer - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API endpoint retrieves a paginated list of all commits associated with a specific pull request in a Bitbucket repository. By making a GET request to this endpoint with the required workspace identifier, repository slug, and pull request ID, developers can access detailed information about each commit included in the pull request, such as commit hashes, authors, timestamps, and commit messages. This is particularly useful for code review processes, tracking changes within a pull request, understanding the development history, and verifying what modifications will be merged when the pull request is accepted. summary: Atlassian List Commits on Pull Request responses: '200': description: A paginated list of commits made on the given pull request, in chronological order. This list will be empty if the source branch no longer exists. '403': description: If the authenticated user does not have access to the pull request. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the pull request does not exist or the source branch is from a forked repository which no longer exists. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: listCommitsOnPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diff: parameters: - name: pull_request_id in: path description: The id of the pull request. required: true schema: type: integer - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: 'The Bitbucket Pull Requests API endpoint `/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diff` retrieves the raw diff or patch output for a specific pull request, showing all code changes between the source and destination branches. This GET operation requires three path parameters: the workspace identifier, repository slug, and pull request ID, and returns the complete textual representation of file modifications, additions, and deletions in unified diff format. The response is particularly useful for code review processes, automated analysis tools, or integration with external systems that need to examine the exact line-by-line changes introduced by a pull request without using the Bitbucket web interface.' summary: Atlassian List Changes in Pull Request responses: '302': description: 'Redirects to the [repository diff](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-diff-spec-get) with the revspec that corresponds to the pull request. ' security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: listChangesInPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses: parameters: - name: pull_request_id in: path description: The id of the pull request. required: true schema: type: integer - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves all commit statuses associated with a specific pull request in a Bitbucket repository. By providing the workspace identifier, repository slug, and pull request ID in the endpoint path, users can fetch a comprehensive list of build statuses, test results, and other automated checks that have been reported for the commits within that pull request. This is particularly useful for monitoring CI/CD pipeline results, understanding the current state of code quality checks, and determining whether a pull request is ready to be merged based on the status of various automated validations and builds that have been executed against its commits. summary: Atlassian List Commit Statuses for Pull Request responses: '200': description: A paginated list of all commit statuses for this pull request. content: application/json: schema: $ref: '#/components/schemas/paginated_commitstatuses' examples: paginated-commit-statuses: $ref: '#/components/examples/paginated-commit-statuses' '401': description: If the repository is private and the request was not authenticated. '404': description: If the specified repository or pull request does not exist. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: q in: query description: 'Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). ' required: false schema: type: string - name: sort in: query description: 'Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). Defaults to `created_on`. ' required: false schema: type: string security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: listCommitStatusesForPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks: parameters: - name: pull_request_id in: path description: The id of the pull request. required: true schema: type: integer - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API endpoint retrieves all tasks associated with a specific pull request in a Bitbucket repository. By making a GET request to /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks, developers can fetch a list of tasks that have been created within the pull request's comments or description, where workspace identifies the Bitbucket workspace, repo_slug specifies the repository, and pull_request_id identifies the particular pull request. This is useful for tracking action items, to-dos, and checklist items that reviewers or collaborators have created during the code review process, enabling teams to manage and monitor outstanding work items before merging the pull request. summary: Atlassian List Tasks on Pull Request responses: '200': description: A paginated list of pull request tasks for the given pull request. content: application/json: schema: $ref: '#/components/schemas/paginated_tasks' examples: paginated-tasks: $ref: '#/components/examples/paginated-tasks' '400': description: If the user provides an invalid filter, sort, or fields query parameter. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: If the authenticated user does not have access to the pull request. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the pull request does not exist. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: q in: query description: ' Query string to narrow down the response. See [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for details.' required: false schema: type: string - name: sort in: query description: ' Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). Defaults to `created_on`. ' required: false schema: type: string - name: pagelen in: query description: ' Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. ' required: false schema: type: integer security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: listTasksOnPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}: parameters: - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a paginated list of all repositories within a specified Bitbucket workspace. By making a GET request to the /repositories/{workspace} endpoint, users can access comprehensive information about repositories that belong to a particular workspace, where the workspace parameter in the URL path identifies the target workspace by its slug or UUID. The response includes repository metadata such as names, descriptions, creation dates, visibility settings (public or private), and associated project information. This endpoint supports various query parameters for filtering, sorting, and pagination, allowing developers to efficiently browse through large collections of repositories and integrate repository listings into their applications or workflows. Authentication is required to access private repositories, and the results respect the user's access permissions within the workspace. summary: Atlassian List Repositories in Workspace responses: '200': description: The repositories owned by the specified account. content: application/json: schema: $ref: '#/components/schemas/paginated_repositories' examples: paginated-repositories_2: $ref: '#/components/examples/paginated-repositories_2' '404': description: If the specified account does not exist. content: application/json: schema: $ref: '#/components/schemas/error' '410': description: If the specified account marked as spam. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: role in: query description: ' Filters the result based on the authenticated user''s role on each repository. * **member**: returns repositories to which the user has explicit read access * **contributor**: returns repositories to which the user has explicit write access * **admin**: returns repositories to which the user has explicit administrator access * **owner**: returns all repositories owned by the current user ' required: false schema: type: string enum: - admin - contributor - member - owner - name: q in: query description: ' Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). ' required: false schema: type: string - name: sort in: query description: "\nField by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n " required: false schema: type: string security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listRepositoriesInWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/branch-restrictions: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This operation retrieves all branch restrictions configured for a specific repository within a Bitbucket workspace. Branch restrictions are rules that control who can push to branches, require pull requests, enforce merge checks, or limit branch deletions. By sending a GET request to this endpoint with the workspace ID and repository slug, you receive a paginated list of all active restrictions including their types, patterns (which branches they apply to), and associated users or groups. This is useful for auditing repository security policies, understanding workflow requirements, or programmatically managing branch protection rules across multiple repositories. summary: Atlassian List Branch Restrictions responses: '200': description: A paginated list of branch restrictions content: application/json: schema: $ref: '#/components/schemas/paginated_branchrestrictions' '401': description: If the request was not authenticated content: application/json: schema: $ref: '#/components/schemas/error' '403': description: If the authenticated user does not have admin access to the repository content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the repository does not exist content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: kind in: query description: Branch restrictions of this type required: false schema: type: string - name: pattern in: query description: Branch restrictions applied to branches of this pattern required: false schema: type: string security: - oauth2: - repository:admin - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - admin:repository:bitbucket operationId: listBranchRestrictions x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}/comments: parameters: - name: commit in: path description: The Commits SHA1. required: true schema: type: string - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves all comments associated with a specific commit in a Bitbucket repository. By providing the workspace identifier, repository slug, and commit hash in the endpoint path, users can fetch a paginated list of comments that have been made on that particular commit. The response includes comment details such as the comment text, author information, creation timestamp, and any associated metadata. This is useful for reviewing feedback, discussions, or code review notes that team members have left on specific commits, enabling better collaboration and tracking of conversations around code changes within the repository's version history. summary: Atlassian List Commits Comments responses: '200': description: A paginated list of commit comments. content: application/json: schema: $ref: '#/components/schemas/paginated_commit_comments' examples: paginated-commit-comments_2: $ref: '#/components/examples/paginated-commit-comments_2' parameters: - name: q in: query description: 'Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). ' required: false schema: type: string - name: sort in: query description: 'Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). ' required: false schema: type: string security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listCommitsComments x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests: get: tags: - Lists summary: Atlassian List Pull Requests That Contain Commit description: This API operation retrieves a list of pull requests that contain a specific commit within a Bitbucket repository. By making a GET request to the endpoint with the workspace identifier, repository slug, and commit hash, developers can discover which pull requests include the specified commit in their change history. This is particularly useful for tracking how code changes have propagated through the development workflow, understanding the context in which a commit was merged, performing impact analysis, or auditing which features or fixes include specific changes. The response returns pull request metadata including titles, authors, status, and related information for all pull requests containing the referenced commit. operationId: listPullRequestsThatContainCommit parameters: - name: workspace in: path description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces required: true schema: type: string - name: repo_slug in: path description: The repository; either the UUID in curly braces, or the slug required: true schema: type: string - name: commit in: path description: The SHA1 of the commit required: true schema: type: string - name: page in: query description: Which page to retrieve required: false schema: type: integer format: int32 default: 1 - name: pagelen in: query description: How many pull requests to retrieve per page required: false schema: type: integer format: int32 default: 30 responses: '200': description: The paginated list of pull requests. content: application/json: schema: $ref: '#/components/schemas/paginated_pullrequests' examples: paginated-pull-requests: $ref: '#/components/examples/paginated-pull-requests_3' '202': description: The repository's pull requests are still being indexed. content: application/json: schema: $ref: '#/components/schemas/paginated_pullrequests' '404': description: Either the repository does not exist, or pull request commit links have not yet been indexed. content: application/json: schema: $ref: '#/components/schemas/error' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket security: - oauth2: - pullrequest - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}/reports: get: tags: - Lists description: This API operation retrieves a paginated list of all reports associated with a specific commit in a Bitbucket repository. By making a GET request to this endpoint with the workspace identifier, repository slug, and commit hash, you can view all reports that have been created for that particular commit, such as code quality analysis results, security scan findings, test coverage reports, or custom build reports. The response includes metadata about each report, allowing developers and CI/CD systems to track and review various automated checks and analyses that have been run against the code changes in that commit. summary: Atlassian List Reports operationId: listReports parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string - name: commit description: The commit for which to retrieve reports. required: true in: path schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/paginated_reports' examples: paginated-reports: $ref: '#/components/examples/paginated-reports' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket security: - oauth2: - repository - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations: get: tags: - Lists description: Returns a paginated list of Annotations for a specific report associated with a commit in a Bitbucket repository. This endpoint allows you to retrieve all annotations that were added to a particular report, which typically includes details about code quality issues, security vulnerabilities, or other automated checks performed on the commit. The annotations provide granular feedback on specific lines or sections of code, including severity levels, paths, line numbers, and descriptive messages. You must specify the workspace, repository slug, commit hash, and report ID to access the annotations, and the results are returned in a paginated format to handle large sets of annotation data efficiently. summary: Atlassian List Annotations operationId: listAnnotations parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string - name: commit description: The commit for which to retrieve reports. required: true in: path schema: type: string - name: reportId description: Uuid or external-if of the report for which to get annotations for. required: true in: path schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/paginated_annotations' examples: paginated-annotations: $ref: '#/components/examples/paginated-annotations' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket security: - oauth2: - repository - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses: parameters: - name: commit in: path description: The Commits SHA1. required: true schema: type: string - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves all build statuses associated with a specific commit in a Bitbucket repository. By providing the workspace ID, repository slug, and commit hash, you can fetch a paginated list of status objects that represent the state of various CI/CD builds, deployments, or other automated checks that have been reported for that particular commit. Each status includes information such as the state (successful, failed, in progress), key, name, URL, description, and timestamp, allowing developers and integrations to track and display the overall health and validation results of a commit across multiple build systems and tools. summary: Atlassian List Commit Statuses for Commit responses: '200': description: A paginated list of all commit statuses for this commit. content: application/json: schema: $ref: '#/components/schemas/paginated_commitstatuses' examples: paginated-commit-statuses: $ref: '#/components/examples/paginated-commit-statuses_3' '401': description: If the repository is private and the request was not authenticated. '404': description: If the repository or commit does not exist content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: q in: query description: 'Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). ' required: false schema: type: string - name: sort in: query description: 'Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). Defaults to `created_on`. ' required: false schema: type: string security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listCommitStatusesForCommit x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commits: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: 'The List Commits operation in the Atlassian Bitbucket Repositories API retrieves a paginated list of commits from a specific repository by making a GET request to the endpoint /repositories/{workspace}/{repo_slug}/commits. This endpoint requires two path parameters: the workspace ID or slug that owns the repository, and the repo_slug which uniquely identifies the repository within that workspace. The response returns commit objects in reverse chronological order by default, with each commit containing metadata such as the commit hash, author information, timestamp, commit message, and parent commit references. Optional query parameters can be used to filter the results by branch, tag, or specific commit ranges, and to control pagination through the result set. This API operation is commonly used for displaying commit history, tracking changes, or integrating repository activity into external tools and dashboards.' summary: Atlassian List Commits responses: '200': description: A paginated list of commits content: application/json: schema: $ref: '#/components/schemas/paginated_changeset' examples: page: $ref: '#/components/examples/page' '404': description: If the specified repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listCommits x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Lists description: The Atlassian Bitbucket Repositories API endpoint /repositories/{workspace}/{repo_slug}/commits allows users to retrieve a paginated list of commits from a specific repository by making a POST request. This operation provides advanced filtering capabilities through include and exclude parameters, enabling developers to narrow down commits based on branches, tags, bookmarks, or specific commit hashes. Users can specify the workspace identifier and repository slug in the path parameters to target a particular repository, while the request body can contain arrays of references to include or exclude from the results. The response returns commit objects containing metadata such as commit hash, author information, commit message, timestamp, and parent references, making it useful for analyzing repository history, generating changelogs, or implementing custom git workflows that require filtered commit information. summary: Atlassian List Commits With Include/exclude responses: '200': description: A paginated list of commits content: application/json: schema: $ref: '#/components/schemas/paginated_changeset' examples: page_2: $ref: '#/components/examples/page_2' '404': description: If the specified repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listCommitsWithIncludeExclude x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commits/{revision}: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: revision in: path description: A commit SHA1 or ref name. required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API endpoint retrieves a paginated list of commits for a specific revision in a Bitbucket repository. By making a GET request to /repositories/{workspace}/{repo_slug}/commits/{revision}, you can access commit history starting from the specified revision, which can be a branch name, tag, or commit SHA. The endpoint returns commit details including author information, commit messages, timestamps, and parent commit references. The response is paginated to handle repositories with extensive commit histories, and you can use query parameters to control pagination and filter results. This operation is useful for tracking changes, auditing code history, or building integrations that need to analyze commit data for a particular branch or point in the repository's timeline. summary: Atlassian List Commits for Revision responses: '200': description: A paginated list of commits content: application/json: schema: $ref: '#/components/schemas/paginated_changeset' examples: page_2: $ref: '#/components/examples/page_2' '404': description: If the specified revision does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listCommitsForRevision x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Lists description: This API operation retrieves a paginated list of commits from a specific repository in Bitbucket that are reachable from a given revision. The endpoint accepts a workspace identifier, repository slug, and a revision parameter (such as a branch name, tag, or commit SHA) in the URL path. It supports POST method to allow for more complex filtering through include and exclude parameters in the request body, enabling users to specify which commits to include or exclude from the results based on branches, tags, or other revisions. This is particularly useful for generating commit histories between specific points in the repository's history or for filtering out commits from certain branches while focusing on others. The response returns commit objects containing information such as commit hash, author, date, message, and parent commits in a paginated format. summary: Atlassian List Commits for Revision Using Include/exclude responses: '200': description: A paginated list of commits content: application/json: schema: $ref: '#/components/schemas/paginated_changeset' examples: page_2: $ref: '#/components/examples/page_2' '404': description: If the specified revision does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - readRepositoryBitbucket operationId: listCommitsForRevisionUsingInclude/Exclude x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/components: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This GET operation retrieves a paginated list of components associated with a specific repository in Bitbucket. By providing the workspace identifier and repository slug in the path parameters, you can access all components that have been defined for issue tracking purposes within that repository. Components are used to organize and categorize issues, allowing teams to group related issues by product areas, modules, or functional aspects of the codebase. The response returns component details including their names, descriptions, and associated metadata, helping developers and project managers understand the structural organization of issues within the repository. summary: Atlassian List Components responses: '200': description: The components that have been defined in the issue tracker. content: application/json: schema: $ref: '#/components/schemas/paginated_components' examples: paginated-components: $ref: '#/components/examples/paginated-components' '404': description: The specified repository does not exist or does not have the issue tracker enabled. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - issue - basic: [] - api_key: [] operationId: listComponents x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/default-reviewers: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API endpoint retrieves the list of default reviewers configured for a specific Bitbucket repository within a workspace. When called with a GET request to /repositories/{workspace}/{repo_slug}/default-reviewers, it returns information about users who are automatically added as reviewers when new pull requests are created in the specified repository. The endpoint requires the workspace identifier and repository slug as path parameters to identify the target repository, and it provides visibility into the repository's pull request review settings, helping teams understand who will be automatically notified and assigned to review code changes. summary: Atlassian List Default Reviewers responses: '200': description: The paginated list of default reviewers content: application/json: schema: $ref: '#/components/schemas/paginated_accounts' examples: paginated-accounts: $ref: '#/components/examples/paginated-accounts' '403': description: If the authenticated user does not have access to view the default reviewers content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: listDefaultReviewers x-api-evangelist-processing: ChooseTags: true WriteDescription: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/deploy-keys: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a paginated list of all deploy keys that have been configured for a specific Bitbucket repository within a workspace. Deploy keys are SSH keys that grant read-only or read-write access to a single repository, commonly used for automated deployment processes or CI/CD pipelines. By sending a GET request to this endpoint with the appropriate workspace identifier and repository slug, authenticated users can view all deploy keys associated with that repository, including details such as the key's label, public key value, creation date, and access permissions, enabling repository administrators to audit and manage automated access to their codebase. summary: Atlassian List Repository Deploy Keys responses: '200': description: Deploy keys matching the repository content: application/json: schema: $ref: '#/components/schemas/paginated_deploy_keys' examples: paginated-deploy-keys: $ref: '#/components/examples/paginated-deploy-keys' '403': description: If the specified user or repository is not accessible to the current user '404': description: If the specified user or repository does not exist content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository - repository:admin - basic: [] - api_key: [] operationId: listRepositoryDeployKeys x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/deployments: get: tags: - Lists description: This API operation retrieves a paginated list of deployments for a specific repository within an Atlassian Bitbucket workspace. By sending a GET request to the endpoint with the workspace identifier and repository slug as path parameters, users can fetch deployment information associated with that repository. The response typically includes details about each deployment such as deployment environment, state, timestamps, and related commit information. This endpoint is useful for tracking and monitoring the deployment history of a repository across different environments like production, staging, or development, enabling teams to maintain visibility over their deployment pipeline and release management processes. summary: Atlassian List Deployments operationId: listDeployments parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string responses: '200': description: The matching deployments. content: application/json: schema: $ref: '#/components/schemas/paginated_deployments' examples: paginated-deployments: $ref: '#/components/examples/paginated-deployments' security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables: get: tags: - Lists description: This GET operation retrieves all deployment variables configured for a specific environment within a Bitbucket repository's deployment configuration. By providing the workspace identifier, repository slug, and environment UUID in the path parameters, the API returns a list of variables that have been defined for that particular deployment environment, including both their names and values. These variables are typically used to store environment-specific configuration settings, credentials, or other data needed during the deployment process to that environment. summary: Atlassian List Variables for an Environment operationId: listVariablesForAnEnvironment parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string - name: environment_uuid description: The environment. required: true in: path schema: type: string responses: '200': description: The retrieved deployment variables. content: application/json: schema: $ref: '#/components/schemas/paginated_deployment_variable' examples: paginated-deployment-variables: $ref: '#/components/examples/paginated-deployment-variables' security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/downloads: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a paginated list of download artifacts that have been uploaded to a specific Bitbucket repository. By making a GET request to the endpoint with the appropriate workspace and repository slug parameters, users can view all files that are available for download from the repository's downloads section. These artifacts are typically release binaries, compiled packages, or other distributable files that repository maintainers want to make available to users separately from the source code. The response includes metadata about each download artifact such as filename, size, upload date, and download URL, allowing developers and automated systems to programmatically access and manage repository downloads. summary: Atlassian List Download Artifacts responses: '200': description: Returns a paginated list of the downloads associated with the repository. '403': description: User is not authorized to read from the repository. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listDownloadArtifacts x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/effective-default-reviewers: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This GET operation retrieves the effective default reviewers for a specific repository in Bitbucket. By calling this endpoint with the workspace and repository slug parameters, you can obtain a list of users who are automatically added as reviewers to pull requests in that repository. The "effective" designation means it returns not only the reviewers explicitly configured for this specific repository, but also includes any default reviewers inherited from workspace-level settings, providing a complete view of all users who will be automatically assigned as reviewers when new pull requests are created in the repository. summary: Atlassian List Effective Default Reviewers responses: '200': description: The paginated list of effective default reviewers content: application/json: schema: $ref: '#/components/schemas/paginated_default_reviewer_and_type' examples: paginated-default-reviewer-and-type: $ref: '#/components/examples/paginated-default-reviewer-and-type' '403': description: If the authenticated user does not have access to view the default reviewers content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: listEffectiveDefaultReviewers x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/environments: get: tags: - Lists description: This API operation retrieves a paginated list of deployment environments configured for a specific Bitbucket repository within a given workspace. By making a GET request to the endpoint with the workspace identifier and repository slug as path parameters, users can view all environments (such as production, staging, or development) that have been set up for the repository, enabling them to manage and track deployments across different stages of their software delivery pipeline. The response includes environment details such as names, types, and associated configurations, which are essential for implementing proper deployment strategies and maintaining environment-specific settings within the Bitbucket ecosystem. summary: Atlassian List Environments operationId: listEnvironments parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string responses: '200': description: The matching environments. content: application/json: schema: $ref: '#/components/schemas/paginated_environments' examples: paginated-deployment-environments: $ref: '#/components/examples/paginated-deployment-environments' security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path}: parameters: - name: commit in: path description: The Commits SHA1. required: true schema: type: string - name: path in: path description: Path to the file. required: true schema: type: string - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves the commit history for a specific file in a Bitbucket repository by listing all commits that have modified the file at the given path. The endpoint requires the workspace ID, repository slug, a specific commit SHA, and the file path as parameters. It returns a paginated list of commits in reverse chronological order, showing each commit that touched the specified file up to and including the provided commit reference. This is particularly useful for tracking changes to individual files, understanding file evolution, performing code archaeology, or identifying when specific changes were introduced to a particular file in the repository's history. summary: Atlassian List Commits That Modified File responses: '200': description: A paginated list of commits that modified the specified file content: application/json: schema: $ref: '#/components/schemas/paginated_files' examples: paginated-files: $ref: '#/components/examples/paginated-files' '404': description: If the repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: renames in: query description: ' When `true`, Bitbucket will follow the history of the file across renames (this is the default behavior). This can be turned off by specifying `false`.' required: false schema: type: string - name: q in: query description: ' Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).' required: false schema: type: string - name: sort in: query description: ' Name of a response property sort the result by as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results). ' required: false schema: type: string security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listCommitsThatModifiedFile x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/forks: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a paginated list of all forks that have been created from a specific Bitbucket repository. By making a GET request to the endpoint with the workspace identifier and repository slug as path parameters, users can view all derivative repositories that have been forked from the original. The response typically includes details about each fork such as the fork's owner, creation date, repository metadata, and links to access the forked repositories. This is useful for repository maintainers who want to track how their code is being used and extended by the community, or for developers looking to discover active forks that may contain interesting modifications or improvements to the original codebase. summary: Atlassian List Repository Forks responses: '200': description: All forks. content: application/json: schema: $ref: '#/components/schemas/paginated_repositories' examples: paginated-repositories_2: $ref: '#/components/examples/paginated-repositories_2' parameters: - name: role in: query description: 'Filters the result based on the authenticated user''s role on each repository. * **member**: returns repositories to which the user has explicit read access * **contributor**: returns repositories to which the user has explicit write access * **admin**: returns repositories to which the user has explicit administrator access * **owner**: returns all repositories owned by the current user ' required: false schema: type: string enum: - admin - contributor - member - owner - name: q in: query description: 'Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). ' required: false schema: type: string - name: sort in: query description: 'Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). ' required: false schema: type: string security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listRepositoryForks x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/hooks: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: The Get List Webhooks For Repository operation in the Atlassian Bitbucket Repositories API allows you to retrieve a paginated list of all webhooks configured for a specific repository within a workspace. By making a GET request to the /repositories/{workspace}/{repo_slug}/hooks endpoint, where {workspace} is the workspace ID or slug and {repo_slug} is the repository identifier, you can view all webhook subscriptions that have been set up to notify external services when specific events occur in the repository, such as push events, pull request updates, or issue changes. The response includes details about each webhook, including its unique identifier, URL endpoint, description, active status, and the events it's subscribed to, making it useful for auditing integrations, managing webhook configurations, or troubleshooting event notifications. summary: Atlassian List Webhooks for Repository responses: '200': description: The paginated list of installed webhooks. content: application/json: schema: $ref: '#/components/schemas/paginated_webhook_subscriptions' examples: paginated-webhook-subscriptions: $ref: '#/components/examples/paginated-webhook-subscriptions' '403': description: If the authenticated user does not have permission to access the webhooks. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - webhook - basic: [] - api_key: [] operationId: listWebhooksForRepository x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/issues: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: The List Issues operation retrieves all issues associated with a specific Bitbucket repository within a workspace. By making a GET request to this endpoint with the workspace ID and repository slug as path parameters, users can access a paginated list of issues including their metadata such as title, description, status, priority, assignee, and creation date. This endpoint supports various query parameters for filtering and sorting issues, making it useful for integrating issue tracking data into external applications, generating reports, or building custom dashboards that need to display repository issues programmatically. summary: Atlassian List Issues responses: '200': description: A paginated list of the issues matching any filter criteria that were provided. content: application/json: schema: $ref: '#/components/schemas/paginated_issues' examples: paginated-issues: $ref: '#/components/examples/paginated-issues' '404': description: The specified repository does not exist or does not have the issue tracker enabled. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - issue - basic: [] - api_key: [] operationId: listIssues x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments: parameters: - name: issue_id in: path description: The issue id required: true schema: type: string - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: Returns all attachments for the specified issue in a Bitbucket repository. This GET endpoint accepts a workspace identifier, repository slug, and issue ID as path parameters to retrieve metadata and download URLs for all files that have been attached to that particular issue. The response includes details such as attachment names, sizes, content types, and links to access each file, making it useful for displaying or downloading issue-related documents, images, or other supporting files programmatively. summary: Atlassian List Attachments for an Issue responses: '200': description: A paginated list of all attachments for this issue. content: application/json: schema: $ref: '#/components/schemas/paginated_issue_attachments' examples: paginated-issue-attachment: $ref: '#/components/examples/paginated-issue-attachment' '401': description: If the issue tracker is private and the request was not authenticated. '404': description: The specified repository or issue does not exist or does not have the issue tracker enabled. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - issue - basic: [] - api_key: [] operationId: listAttachmentsForAnIssue x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes: parameters: - name: issue_id in: path description: The issue id required: true schema: type: string - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: Returns all the issue changes that were made on the specified issue. This endpoint retrieves the complete change history for a particular issue in a Bitbucket repository, allowing you to track modifications such as status updates, assignee changes, priority adjustments, and other field modifications over time. The response includes details about who made each change, when it occurred, and what specifically was altered, providing full audit trail capabilities for issue tracking and management within the workspace's repository. summary: Atlassian List Changes on an Issue responses: '200': description: Returns all the issue changes that were made on the specified issue. content: application/json: schema: $ref: '#/components/schemas/paginated_log_entries' examples: paginated-log-entries: $ref: '#/components/examples/paginated-log-entries' '404': description: The specified repository or issue does not exist or does not have the issue tracker enabled. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: q in: query description: ' Query string to narrow down the response. See [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for details.' required: false schema: type: string - name: sort in: query description: ' Name of a response property to sort results. See [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results) for details. ' required: false schema: type: string security: - oauth2: - issue - basic: [] - api_key: [] operationId: listChangesOnAnIssue x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments: parameters: - name: issue_id in: path description: The issue id required: true schema: type: string - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This GET operation retrieves all comments associated with a specific issue in a Bitbucket repository. By providing the workspace identifier, repository slug, and issue ID as path parameters, the endpoint returns a paginated list of comments that have been posted on that particular issue. The response includes comment metadata such as the comment content, author information, creation and update timestamps, and any related links. This is useful for developers and project managers who need to review discussions, feedback, or troubleshooting information related to a specific issue within their repository's issue tracking system. summary: Atlassian List Comments on an Issue responses: '200': description: A paginated list of issue comments. content: application/json: schema: $ref: '#/components/schemas/paginated_issue_comments' examples: paginated-issue-comments: $ref: '#/components/examples/paginated-issue-comments' parameters: - name: q in: query description: ' Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).' required: false schema: type: string security: - oauth2: - issue - basic: [] - api_key: [] operationId: listCommentsOnAnIssue x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/milestones: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This GET operation retrieves a paginated list of milestones associated with a specific repository in Bitbucket. By providing the workspace identifier and repository slug in the URL path, users can access all milestones that have been created for that repository, which are typically used to track progress toward specific goals or releases. The response returns milestone details such as names, descriptions, due dates, and current states, allowing teams to monitor project planning and progress tracking within their Bitbucket repositories. This endpoint is useful for integration with project management tools, creating dashboards, or automating milestone-related workflows. summary: Atlassian List Milestones responses: '200': description: The milestones that have been defined in the issue tracker. content: application/json: schema: $ref: '#/components/schemas/paginated_milestones' examples: paginated-milestones: $ref: '#/components/examples/paginated-milestones' '404': description: The specified repository does not exist or does not have the issue tracker enabled. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - issue - basic: [] - api_key: [] operationId: listMilestones x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/permissions-config/groups: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a paginated list of all explicit group permissions that have been configured for a specific Bitbucket repository within a workspace. It returns permission configurations that directly grant access to groups at the repository level, as opposed to inherited or default permissions. The endpoint requires both the workspace identifier and repository slug to be specified in the URL path, and it returns details about which groups have been explicitly granted permissions to access or interact with the repository, along with the specific permission levels assigned to each group. summary: Atlassian List Explicit Group Permissions for Repository responses: '200': description: Paginated of explicit group permissions on the repository. content: application/json: schema: $ref: '#/components/schemas/paginated_repository_group_permissions' examples: paginated-repository-group-permissions: $ref: '#/components/examples/paginated-repository-group-permissions' '401': description: The user couldn't be authenticated. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: The requesting user isn't an admin of the repository. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: One or both of the workspace and repository doesn't exist for the given identifiers. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository:admin - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket - read:user:bitbucket operationId: listExplicitGroupPermissionsForRepository x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/permissions-config/users: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a list of explicit user permissions that have been directly assigned to a specific Bitbucket repository within a given workspace. By making a GET request to the endpoint with the workspace identifier and repository slug as path parameters, it returns detailed information about individual users who have been granted specific permission levels on the repository, excluding permissions inherited through group memberships or workspace-level settings. This is useful for repository administrators who need to audit, review, or manage direct user access controls and understand exactly which users have been explicitly granted permissions such as read, write, or admin access to the repository. summary: Atlassian List Explicit User Permissions for Repository responses: '200': description: Paginated of explicit user permissions on the repository. content: application/json: schema: $ref: '#/components/schemas/paginated_repository_user_permissions' examples: paginated-repository-user-permissions: $ref: '#/components/examples/paginated-repository-user-permissions' '401': description: The user couldn't be authenticated. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: The requesting user isn't an admin of the repository. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: No repository exists for the given repository slug and workspace. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository:admin - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket - read:user:bitbucket operationId: listExplicitUserPermissionsForRepository x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines: get: tags: - Lists summary: Atlassian List Pipelines description: This API operation retrieves a paginated list of all pipelines executed for a specific Bitbucket repository within a workspace. By making a GET request to the endpoint with the workspace identifier and repository slug as path parameters, users can access comprehensive information about their repository's CI/CD pipeline runs, including pipeline execution status, build numbers, creation dates, and associated commit details. The response returns pipeline objects in reverse chronological order, making it useful for monitoring build history, tracking deployment workflows, and analyzing CI/CD pipeline performance across the repository. operationId: listPipelines parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string responses: '200': description: The matching pipelines. content: application/json: schema: $ref: '#/components/schemas/paginated_pipelines' examples: paginated-pipelines: $ref: '#/components/examples/paginated-pipelines' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pipeline:bitbucket security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines-config/caches: get: tags: - Lists summary: Atlassian List Caches description: This GET operation retrieves a list of all configured build caches for a specific repository's pipeline in Bitbucket. By targeting the pipelines-config/caches endpoint under a particular workspace and repository slug, it returns information about the caching configurations that have been set up to optimize build times by storing dependencies and other reusable build artifacts. The response typically includes details such as cache names, sizes, and related metadata that help developers understand what content is being cached for their CI/CD pipelines. This endpoint is useful for monitoring cache usage, troubleshooting build performance issues, and managing pipeline resources within a Bitbucket repository. operationId: listCaches parameters: - name: workspace description: The account. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string responses: '200': description: The list of caches for the given repository. content: application/json: schema: $ref: '#/components/schemas/paginated_pipeline_caches' examples: paginated-pipeline-cache: $ref: '#/components/examples/paginated-pipeline-cache' '404': description: The account or repository was not found. content: application/json: schema: $ref: '#/components/schemas/error' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pipeline:bitbucket security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps: get: tags: - Lists summary: Atlassian List Steps for Pipeline description: Retrieves a paginated list of all build steps that belong to a specific pipeline execution in a Bitbucket repository. This endpoint requires the workspace identifier, repository slug, and pipeline UUID as path parameters to locate the target pipeline, then returns detailed information about each step in the pipeline's execution sequence including their status, duration, commands executed, and any associated logs or artifacts. The response provides visibility into the individual stages of a CI/CD pipeline run, allowing developers and DevOps teams to monitor progress, debug failures, and analyze the execution flow of their automated builds and deployments. operationId: listStepsForPipeline parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string - name: pipeline_uuid description: The UUID of the pipeline. required: true in: path schema: type: string responses: '200': description: The steps. content: application/json: schema: $ref: '#/components/schemas/paginated_pipeline_steps' examples: paginated-pipeline-steps: $ref: '#/components/examples/paginated-pipeline-steps' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pipeline:bitbucket security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines_config/schedules: get: tags: - Lists summary: Atlassian List Schedules description: This GET operation retrieves a list of all configured pipeline schedules for a specific repository within a Bitbucket workspace. By providing the workspace identifier and repository slug in the endpoint path, users can view all automated pipeline execution schedules that have been set up for that repository, including details such as schedule timing, enabled status, target branches, and schedule configuration parameters. This is useful for managing and auditing automated CI/CD workflows, allowing teams to see when pipelines are scheduled to run without manual triggering. operationId: listSchedules parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string responses: '200': description: The list of schedules. content: application/json: schema: $ref: '#/components/schemas/paginated_pipeline_schedules' examples: paginated-pipeline-schedule: $ref: '#/components/examples/paginated-pipeline-schedule' '404': description: The account or repository was not found. content: application/json: schema: $ref: '#/components/schemas/error' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pipeline:bitbucket security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions: get: tags: - Lists summary: Atlassian List Executions of Schedule description: This API endpoint retrieves a list of all pipeline executions that have been triggered by a specific schedule in a Bitbucket repository. By providing the workspace identifier, repository slug, and schedule UUID in the path, users can view the historical execution records for that particular scheduled pipeline. This is useful for monitoring and auditing purposes, allowing teams to track when scheduled pipelines have run, verify their execution history, and identify any patterns or issues with automated pipeline triggers. The endpoint returns execution details that help developers understand how their scheduled CI/CD processes are performing over time. operationId: listExecutionsOfSchedule parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string - name: schedule_uuid description: The uuid of the schedule. required: true in: path schema: type: string responses: '200': description: The list of executions of a schedule. content: application/json: schema: $ref: '#/components/schemas/paginated_pipeline_schedule_executions' examples: paginated-pipeline-schedule-executions: $ref: '#/components/examples/paginated-pipeline-schedule-executions' '404': description: The account or repository was not found. content: application/json: schema: $ref: '#/components/schemas/error' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pipeline:bitbucket security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts: get: tags: - Lists summary: Atlassian List Known Hosts description: This API endpoint retrieves a list of configured SSH known hosts for a specific Bitbucket repository's pipeline configuration. By making a GET request to `/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts`, developers can view all SSH host fingerprints that have been added to the repository's pipeline settings, which are used to verify the identity of remote servers during SSH connections in CI/CD pipeline executions. The endpoint requires the workspace identifier and repository slug as path parameters, and typically returns details about each known host including the hostname, public key type, and the actual SSH key fingerprint that will be used for host verification during automated builds and deployments. operationId: listKnownHosts parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string responses: '200': description: The retrieved known hosts. content: application/json: schema: $ref: '#/components/schemas/paginated_pipeline_known_hosts' examples: paginated-pipeline-known-hosts: $ref: '#/components/examples/paginated-pipeline-known-hosts' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pipeline:bitbucket security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines_config/variables: get: tags: - Lists summary: Atlassian List Variables for Repository description: This API operation retrieves all pipeline variables configured for a specific Bitbucket repository within a given workspace. By making a GET request to the endpoint with the workspace identifier and repository slug, users can access a complete list of environment variables that are available for use during pipeline executions. These variables typically include configuration settings, credentials, and other key-value pairs that pipelines reference during build, test, and deployment processes. The operation returns variable metadata including names, values (with sensitive values potentially masked), security settings, and whether variables are secured or public. This is useful for auditing pipeline configurations, managing environment-specific settings, and ensuring proper variable setup across different repositories in the workspace. operationId: listVariablesForRepository parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string - name: repo_slug description: The repository. required: true in: path schema: type: string responses: '200': description: The retrieved variables. content: application/json: schema: $ref: '#/components/schemas/paginated_pipeline_variables' examples: paginated-pipeline-variables: $ref: '#/components/examples/paginated-pipeline-variables' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pipeline:bitbucket security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/refs: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API endpoint retrieves a paginated list of references (branches and tags) for a specific repository within a Bitbucket workspace. By making a GET request to /repositories/{workspace}/{repo_slug}/refs, you can access all branch and tag references associated with the repository, where {workspace} represents the workspace ID or username and {repo_slug} identifies the specific repository. The response typically includes reference names, target commit hashes, and reference types, allowing developers to programmatically discover and work with the various branches and tags that exist in the repository for operations like branch comparison, deployment workflows, or repository analysis. summary: Atlassian List Branches and Tags responses: '200': description: A paginated list of refs matching any filter criteria that were provided. content: application/json: schema: $ref: '#/components/schemas/paginated_refs' examples: paginated-refs: $ref: '#/components/examples/paginated-refs' '403': description: 'If the repository is private and the authenticated user does not have access to it. ' content: application/json: schema: $ref: '#/components/schemas/error' '404': description: The specified repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: q in: query description: ' Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).' schema: type: string - name: sort in: query description: ' Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name` field is handled specially for refs in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return [''1.1'', ''1.2'', ''1.10''] instead of [''1.1'', ''1.10'', ''1.2''].' schema: type: string security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listBranchesAndTags x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/refs/branches: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a paginated list of all branches in a specified Bitbucket repository by providing the workspace identifier and repository slug in the path parameters. It returns comprehensive branch information including branch names, associated commit details, target information, and metadata about each branch's state. The response follows Bitbucket's standard pagination format, making it suitable for repositories with numerous branches, and is commonly used for displaying available branches, implementing branch selection interfaces, or auditing repository branch structure. summary: Atlassian List Open Branches responses: '200': description: A paginated list of branches matching any filter criteria that were provided. content: application/json: schema: $ref: '#/components/schemas/paginated_branches' examples: paginated-branches: $ref: '#/components/examples/paginated-branches' '403': description: 'If the repository is private and the authenticated user does not have access to it. ' content: application/json: schema: $ref: '#/components/schemas/error' '404': description: The specified repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: q in: query description: ' Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).' schema: type: string - name: sort in: query description: ' Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name` field is handled specially for branches in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return [''branch1'', ''branch2'', ''branch10''] instead of [''branch1'', ''branch10'', ''branch2''].' schema: type: string security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listOpenBranches x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/refs/tags: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a paginated list of all tags in a specified Bitbucket repository within a given workspace. By making a GET request to the endpoint with the workspace identifier and repository slug as path parameters, users can fetch metadata about repository tags, which are references that point to specific commits in the version control history. The response typically includes information such as tag names, target commit hashes, creation dates, and associated metadata, allowing developers to programmatically access and manage repository tags for version control, release management, and deployment workflows. summary: Atlassian List Tags responses: '200': description: A paginated list of tags matching any filter criteria that were provided. content: application/json: schema: $ref: '#/components/schemas/paginated_tags' '403': description: 'If the repository is private and the authenticated user does not have access to it. ' content: application/json: schema: $ref: '#/components/schemas/error' '404': description: The specified repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: q in: query description: ' Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).' schema: type: string - name: sort in: query description: ' Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name` field is handled specially for tags in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return [''1.1'', ''1.2'', ''1.10''] instead of [''1.1'', ''1.10'', ''1.2''].' schema: type: string security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listTags x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/versions: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: 'This API endpoint retrieves a paginated list of all defined versions associated with a specific repository in Bitbucket. By making a GET request to /repositories/{workspace}/{repo_slug}/versions, users can access version information that is typically used for issue tracking and release management within the repository. The endpoint requires two path parameters: the workspace identifier and the repository slug, which together uniquely identify the target repository. The response returns version objects that may include details such as version names, identifiers, and metadata that teams use to categorize and track issues across different releases or milestones of their software project.' summary: Atlassian List Defined Versions for Issues responses: '200': description: The versions that have been defined in the issue tracker. content: application/json: schema: $ref: '#/components/schemas/paginated_versions' examples: paginated-versions: $ref: '#/components/examples/paginated-versions' '404': description: The specified repository does not exist or does not have the issue tracker enabled. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - issue - basic: [] - api_key: [] operationId: listDefinedVersionsForIssues x-api-evangelist-processing: ChooseTags: true WriteDescription: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/watchers: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: Returns a paginated list of all users watching the specified repository. Authenticated users can use this endpoint to discover who is following updates to a repository, including receiving notifications about commits, pull requests, and issues. The response includes user account information for each watcher. This endpoint supports pagination through standard query parameters to handle repositories with large numbers of watchers. Access requires appropriate repository read permissions, with the level of detail returned depending on the authenticated user's privileges and the repository's visibility settings. summary: Atlassian List Repositories Watchers responses: '200': description: A paginated list of all the watchers on the specified repository. content: application/json: schema: $ref: '#/components/schemas/paginated_accounts' examples: paginated-accounts_2: $ref: '#/components/examples/paginated-accounts_2' security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: listRepositoriesWatchers x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/permissions/repositories/{repo_slug}: parameters: - name: repo_slug in: path description: 'This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves all explicit user and group permissions for a specific repository within a given workspace in Bitbucket. By providing the workspace identifier and repository slug as path parameters, it returns a paginated list of permission grants that shows which users and groups have been explicitly granted access to the repository and their respective permission levels (such as read, write, or admin). This is useful for auditing repository access, managing team permissions, and understanding who has what level of access to a particular repository within the workspace, excluding any permissions that might be inherited from workspace-level settings. summary: Atlassian List Repository Permissions for Workspace responses: '200': description: The repository permission for all users in this repository. content: application/json: schema: $ref: '#/components/schemas/paginated_repository_permissions' examples: paginated-repository-permissions: $ref: '#/components/examples/paginated-repository-permissions' '403': description: The requesting user isn't an admin of the repository. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: q in: query description: ' Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).' required: false schema: type: string - name: sort in: query description: ' Name of a response property sort the result by as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results). ' required: false schema: type: string security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket - read:user:bitbucket operationId: listRepositoryPermissionsForWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}: parameters: - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a paginated list of all code snippets that belong to a specific workspace in Bitbucket. By making a GET request to the endpoint with a workspace identifier, users can access all snippets created within that workspace, regardless of their owner or visibility settings. The response typically includes snippet metadata such as titles, descriptions, creation dates, and file information, allowing developers to browse and discover code snippets shared within their team's workspace. This is particularly useful for teams who want to centrally manage and access reusable code fragments, examples, or documentation stored as snippets within their Bitbucket workspace. summary: Atlassian List Snippets in Workspace responses: '200': description: A paginated list of snippets. content: application/json: schema: $ref: '#/components/schemas/paginated_snippets' examples: paginated-snippets: $ref: '#/components/examples/paginated-snippets' '404': description: If the user does not exist. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: role in: query description: Filter down the result based on the authenticated user's role (`owner`, `contributor`, or `member`). required: false schema: type: string enum: - owner - contributor - member security: - oauth2: - snippet - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true operationId: listSnippetsInWorkspace x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}/{encoded_id}/comments: parameters: - name: encoded_id in: path description: The snippet id. required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: The Get Comments endpoint retrieves all comments associated with a specific snippet in Bitbucket by providing the workspace identifier and the encoded snippet ID in the URL path. This operation returns a paginated list of comments that users have added to the snippet, allowing developers to display discussion threads, feedback, or collaborative notes related to the code snippet. The response includes comment metadata such as the author, timestamp, and comment content, enabling applications to build interactive commenting features or analyze snippet discussions within a workspace. summary: Atlassian List Comments on Snippet responses: '200': description: A paginated list of snippet comments, ordered by creation date. content: application/json: schema: $ref: '#/components/schemas/paginated_snippet_comments' examples: paginated-snippet-comments: $ref: '#/components/examples/paginated-snippet-comments' '403': description: If the authenticated user does not have access to the snippet. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the snippet does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - snippet - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true operationId: listCommentsOnSnippet x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}/{encoded_id}/commits: parameters: - name: encoded_id in: path description: The snippet id. required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a paginated list of commits that have been made to a specific snippet within an Atlassian Bitbucket workspace. By providing the workspace identifier and the encoded snippet ID in the endpoint path, users can track the revision history and changes made to the snippet over time. The GET request returns commit information including details such as commit hashes, authors, timestamps, and commit messages, allowing developers to audit modifications, understand the evolution of code snippets, and potentially revert to previous versions if needed. This is particularly useful for teams collaborating on shared code snippets who need visibility into who changed what and when. summary: Atlassian List Snippet Changes responses: '200': description: The paginated list of snippet commits. content: application/json: schema: $ref: '#/components/schemas/paginated_snippet_commit' examples: paginated-snippet-commits: $ref: '#/components/examples/paginated-snippet-commits' '403': description: If the authenticated user does not have access to the snippet. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the snippet does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - snippet - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true operationId: listSnippetChanges x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}/{encoded_id}/watchers: parameters: - name: encoded_id in: path description: The snippet id. required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API endpoint retrieves a paginated list of all users who are currently watching a specific snippet in Bitbucket. By making a GET request to /snippets/{workspace}/{encoded_id}/watchers, you can access information about the watchers of a snippet identified by its encoded ID within a particular workspace. The endpoint returns user details for each watcher, allowing snippet owners and authorized users to see who is monitoring the snippet for updates or changes. This is useful for understanding the audience and engagement level of shared code snippets within a team or organization. summary: Atlassian List Users Watching Snippet responses: '200': description: The paginated list of users watching this snippet content: application/json: schema: $ref: '#/components/schemas/paginated_accounts_2' examples: paginated-accounts: $ref: '#/components/examples/paginated-accounts_3' '404': description: If the snippet does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - snippet - basic: [] - api_key: [] deprecated: true x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true operationId: listUsersWatchingSnippet x-microcks-operation: delay: 0 dispatcher: FALLBACK /teams/{username}/pipelines_config/variables: get: tags: - Lists summary: Atlassian List Variables for an Account deprecated: true description: The List Variables for an Account operation in the Atlassian Bitbucket Teams API retrieves all pipeline variables configured at the account level for a specified team or workspace. By making a GET request to the `/teams/{username}/pipelines_config/variables` endpoint with the appropriate team username, developers can access a collection of environment variables that are available across all repositories within that account's Bitbucket Pipelines configuration. These variables typically include sensitive configuration data such as API keys, credentials, and deployment settings that are secured and reusable across multiple pipeline executions. The response returns details about each variable including its name, value (if not secured), UUID, and whether it is marked as secured or encrypted, allowing teams to audit and manage their pipeline configuration effectively. operationId: listVariablesForAnAccount parameters: - name: username description: The account. required: true in: path schema: type: string responses: '200': description: The found account level variables. content: application/json: schema: $ref: '#/components/schemas/paginated_pipeline_variables' examples: paginated-pipeline-variables: $ref: '#/components/examples/paginated-pipeline-variables_2' security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/emails: parameters: [] get: tags: - Lists description: This API operation retrieves all email addresses associated with the currently authenticated Bitbucket Users account. When invoked with a GET request to the /user/emails endpoint, it returns a collection of email addresses linked to the user, typically including details such as the email address itself, whether it's the primary email, and its verification status. This endpoint is useful for applications that need to access or display the Users registered email addresses, manage email preferences, or verify communication channels for the authenticated user within the Bitbucket platform. summary: Atlassian List Email Addresses for Current User responses: default: description: Unexpected error. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - email - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true operationId: listEmailAddressesForCurrentUser x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/permissions/repositories: parameters: [] get: tags: - Lists description: This API endpoint retrieves a paginated list of repositories for which the authenticated user has explicit permissions in Bitbucket. It returns repository objects along with the specific permission level (read, write, or admin) that the user has been granted for each repository. The response excludes repositories where the user has inherited permissions through team or group membership, focusing only on direct permission assignments. This operation requires authentication and uses a GET request method, making it useful for applications that need to audit or display a Users directly assigned repository access rights across their Bitbucket workspace. summary: Atlassian List Repository Permissions for User responses: '200': description: Repository permissions for the repositories a caller has explicit access to. content: application/json: schema: $ref: '#/components/schemas/paginated_repository_permissions' examples: paginated-repository-permissions: $ref: '#/components/examples/paginated-repository-permissions_2' parameters: - name: q in: query description: ' Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).' required: false schema: type: string - name: sort in: query description: ' Name of a response property sort the result by as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).' required: false schema: type: string security: - oauth2: - account - repository - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true operationId: listRepositoryPermissionsForUser x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/permissions/workspaces: parameters: [] get: tags: - Lists description: This API operation retrieves a list of workspaces that the currently authenticated user has permissions to access in Atlassian Bitbucket. By making a GET request to the /user/permissions/workspaces endpoint, developers can programmatically discover which workspaces are available to the authenticated user based on their account permissions and access rights. This is particularly useful for applications that need to dynamically populate workspace selection interfaces, validate user access before performing operations, or build administrative tools that work across multiple Bitbucket workspaces. The endpoint returns workspace information including workspace identifiers, names, and the specific permission levels the user holds within each workspace. summary: Atlassian List Workspaces for the Current User responses: '200': description: All of the workspace memberships for the authenticated user. content: application/json: schema: $ref: '#/components/schemas/paginated_workspace_memberships' examples: paginated-workspace-memberships: $ref: '#/components/examples/paginated-workspace-memberships' '401': description: The request wasn't authenticated. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: q in: query description: ' Query string to narrow down the response. See [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for details.' required: false schema: type: string - name: sort in: query description: ' Name of a response property to sort results. See [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results) for details. ' required: false schema: type: string security: - oauth2: - account - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true operationId: listWorkspacesForTheCurrentUser x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/{selected_user}/pipelines_config/variables: get: tags: - Lists deprecated: true summary: Atlassian List Variables for User description: This API operation retrieves a list of pipeline configuration variables associated with a specific user in Atlassian Bitbucket. By sending a GET request to the endpoint with a selected user identifier, it returns the pipeline variables that have been configured at the user level, which can be used across multiple repositories and pipelines for that particular user. These variables typically include configuration settings, credentials, or other values needed for pipeline execution, allowing users to centralize and manage their pipeline configurations efficiently without having to duplicate them across different repositories. operationId: listVariablesForUser parameters: - name: selected_user description: Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID. required: true in: path schema: type: string responses: '200': description: The found user level variables. content: application/json: schema: $ref: '#/components/schemas/paginated_pipeline_variables' examples: paginated-pipeline-variables: $ref: '#/components/examples/paginated-pipeline-variables_3' security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/{selected_user}/ssh-keys: parameters: - name: selected_user in: path description: 'This can either be an Atlassian Account ID OR the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. ' required: true schema: type: string get: tags: - Lists description: Returns a paginated list of the user's SSH keys for the selected user account in Bitbucket. This endpoint retrieves all public SSH keys that have been added to the specified user's profile, which are used for secure Git operations over SSH protocol. The response includes key details such as the key ID, label, public key content, and creation date. Authentication is required to access this endpoint, and users can only view SSH keys for their own account unless they have appropriate administrative permissions. summary: Atlassian List Ssh Keys responses: '200': description: A list of the SSH keys associated with the account. content: application/json: schema: $ref: '#/components/schemas/paginated_ssh_user_keys' examples: response: value: page: 1 pagelen: 10 size: 1 values: - comment: user@myhost created_on: '2018-03-14T13:17:05.196003+00:00' key: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIKqP3Cr632C2dNhhgKVcon4ldUSAeKiku2yP9O9/bDtY label: '' last_used: '2018-03-20T13:18:05.196003+00:00' links: self: href: https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/ssh-keys/b15b6026-9c02-4626-b4ad-b905f99f763a owner: display_name: Mark Adams links: avatar: href: https://bitbucket.org/account/markadams-atl/avatar/32/ html: href: https://bitbucket.org/markadams-atl/ self: href: https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e} type: user username: markadams-atl nickname: markadams-atl uuid: '{d7dd0e2d-3994-4a50-a9ee-d260b6cefdab}' type: ssh_key uuid: '{b15b6026-9c02-4626-b4ad-b905f99f763a}' '403': description: If the specified Users keys are not accessible to the current user '404': description: If the specified user does not exist content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - account - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true operationId: listSshKeys x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/projects/{project_key}/permissions-config/users: parameters: - name: project_key in: path description: 'The project in question. This is the actual key assigned to the project. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a list of explicit user permissions that have been granted for a specific project within a Bitbucket workspace. By providing the workspace identifier and project key as path parameters, the endpoint returns details about individual users who have been explicitly assigned permissions to the project, including their access levels and roles. This allows administrators to audit and review which users have direct access to a particular project, separate from any permissions they might inherit through group memberships or workspace-level settings. summary: Atlassian List Explicit User Permissions for Project responses: '200': description: Paginated list of explicit user permissions. content: application/json: schema: $ref: '#/components/schemas/paginated_project_user_permissions' examples: paginated-project-user-permissions: $ref: '#/components/examples/paginated-project-user-permissions' '401': description: The user couldn't be authenticated. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: The user doesn't have admin access to the project. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: One or both of the workspace and project don't exist for the given identifiers or the requesting user is not authenticated content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - project:admin - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:project:bitbucket - read:user:bitbucket x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true operationId: listExplicitUserPermissionsForProject x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/hooks: parameters: - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a paginated list of all webhooks that have been configured for a specific Bitbucket workspace. By making a GET request to the /workspaces/{workspace}/hooks endpoint with the workspace identifier, users can view all webhook subscriptions associated with that workspace, including details about the webhook URLs, events they're subscribed to, and their current status. This is useful for auditing, managing, or discovering existing webhook integrations that send HTTP callbacks to external services when specific events occur within the workspace, such as repository pushes, pull request updates, or other Bitbucket activities. summary: Atlassian List Webhooks for a Workspace responses: '200': description: The paginated list of installed webhooks. content: application/json: schema: $ref: '#/components/schemas/paginated_webhook_subscriptions' examples: paginated-webhook-subscriptions: $ref: '#/components/examples/paginated-webhook-subscriptions_2' '403': description: If the authenticated user is not an owner on the specified workspace. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the specified workspace does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - webhook - basic: [] - api_key: [] operationId: atlassianListWebhooksForAWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/members: parameters: - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API endpoint retrieves a list of all members who belong to a specified Atlassian Bitbucket workspace by making a GET request to /workspaces/{workspace}/members, where {workspace} is replaced with the unique identifier or slug of the target workspace. The operation returns member details including user information, roles, and permissions for each member associated with the workspace, allowing administrators and authorized users to view and manage workspace membership. This is particularly useful for auditing purposes, managing team access, or integrating workspace member data with external systems for user management and collaboration workflows. summary: Atlassian List Users in a Workspace responses: '200': description: The list of users that are part of a workspace. content: application/json: schema: $ref: '#/components/schemas/paginated_workspace_memberships' examples: paginated-workspace-memberships: $ref: '#/components/examples/paginated-workspace-memberships_3' '401': description: The request wasn't authenticated. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - account - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:workspace:bitbucket - read:user:bitbucket operationId: atlassianListUsersInAWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/permissions: parameters: - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a list of user permissions configured within a specific Bitbucket workspace by making a GET request to the /workspaces/{workspace}/permissions endpoint, where {workspace} is the unique identifier or slug of the target workspace. It returns detailed information about which users have been granted access to the workspace and their corresponding permission levels, such as member, admin, or collaborator roles. This endpoint is useful for workspace administrators who need to audit user access, manage team permissions, or integrate workspace permission data into external systems for security and compliance purposes. The response typically includes user details like usernames, display names, and their associated permission grants within the specified workspace context. summary: Atlassian List User Permissions in a Workspace responses: '200': description: The list of users that are part of a workspace, along with their permission. content: application/json: schema: $ref: '#/components/schemas/paginated_workspace_memberships' examples: paginated-workspace-memberships_2: $ref: '#/components/examples/paginated-workspace-memberships_2' '401': description: The request wasn't authenticated. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: q in: query description: ' Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).' required: false schema: type: string security: - oauth2: - account - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:workspace:bitbucket - read:user:bitbucket operationId: atlassianListUserPermissionsInAWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/permissions/repositories: parameters: - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This GET operation retrieves a comprehensive list of all repository permissions configured within a specific Bitbucket workspace. By targeting the /workspaces/{workspace}/permissions/repositories endpoint, it returns permission details for repositories in the specified workspace, allowing administrators and authorized users to audit access controls and understand who has what level of access (read, write, admin) to repositories. The {workspace} path parameter identifies the target workspace, and the response typically includes information about users, groups, and their associated permission levels across all repositories within that workspace scope. summary: Atlassian List All Repository Permissions for a Workspace responses: '200': description: List of workspace's repository permissions. content: application/json: schema: $ref: '#/components/schemas/paginated_repository_permissions' examples: paginated-repository-permissions: $ref: '#/components/examples/paginated-repository-permissions' '403': description: The requesting user isn't an admin of the workspace. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: q in: query description: ' Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).' required: false schema: type: string - name: sort in: query description: ' Name of a response property sort the result by as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results). ' required: false schema: type: string security: - oauth2: - account - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket - read:user:bitbucket operationId: atlassianListAllRepositoryPermissionsForAWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/pipelines-config/variables: get: tags: - Lists summary: Atlassian List Variables for a Workspace description: This API operation retrieves all pipeline variables configured at the workspace level in Bitbucket. By making a GET request to the specified endpoint with a workspace identifier, developers can access a list of environment variables that are available to all pipelines within that workspace, including both secured and non-secured variables along with their keys, values (for non-secured variables), and associated metadata. This is useful for managing and auditing centralized configuration settings that apply across multiple repositories within a workspace, enabling administrators to review what variables are defined and available for pipeline executions without needing to check individual repository settings. operationId: atlassianGetpipelinevariablesforworkspace parameters: - name: workspace description: This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`. required: true in: path schema: type: string responses: '200': description: The found workspace level variables. content: application/json: schema: $ref: '#/components/schemas/paginated_pipeline_variables' examples: paginated-pipeline-variables: $ref: '#/components/examples/paginated-pipeline-variables_4' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pipeline:bitbucket security: - oauth2: - pipeline - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/projects: parameters: - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API operation retrieves a paginated list of all projects within a specified Bitbucket workspace, where the workspace is identified by its slug in the URL path. It returns project information including project keys, names, descriptions, and other metadata associated with each project that the authenticated user has permission to view. The response follows Bitbucket's standard pagination format, allowing clients to navigate through large result sets using page parameters, making it useful for applications that need to display or process all projects belonging to a particular workspace. summary: Atlassian List Projects in a Workspace responses: '200': description: The list of projects in this workspace. content: application/json: schema: $ref: '#/components/schemas/paginated_projects' examples: paginated-projects: $ref: '#/components/examples/paginated-projects' '404': description: A workspace doesn't exist at this location. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - project - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:project:bitbucket operationId: atlassianListProjectsInAWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/projects/{project_key}/default-reviewers: parameters: - name: project_key in: path description: 'The project in question. This is the actual `key` assigned to the project. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API endpoint retrieves the list of default reviewers configured for a specific project within a Bitbucket workspace. When accessed via a GET request to `/workspaces/{workspace}/projects/{project_key}/default-reviewers`, it returns information about users who are automatically added as reviewers to new pull requests in the specified project. The endpoint requires both the workspace slug and project key as path parameters to identify the target project. Default reviewers help streamline the code review process by ensuring that designated team members are automatically notified and assigned to review pull requests, maintaining consistency in code quality oversight across the project. summary: Atlassian List the Default Reviewers in a Project responses: '200': description: The list of project default reviewers content: application/json: schema: $ref: '#/components/schemas/paginated_default_reviewer_and_type' examples: paginated-default-reviewer-and-type: $ref: '#/components/examples/paginated-default-reviewer-and-type' '403': description: If the authenticated user does not have admin access to the project content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the workspace or project does not exist at this location content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - project:admin - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: atlassianListTheDefaultReviewersInAProject x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/projects/{project_key}/deploy-keys: parameters: - name: project_key in: path description: 'The project in question. This is the actual `key` assigned to the project. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This GET operation retrieves a paginated list of all deploy keys configured for a specific project within a Bitbucket workspace. Deploy keys are SSH keys that grant read-only or read-write access to project repositories, commonly used for automated deployments and CI/CD pipelines. The endpoint requires both the workspace slug and project key as path parameters to identify the target project, and returns an array of deploy key objects containing details such as the key ID, label, public key value, creation date, and associated permissions. This allows administrators and developers to audit which deploy keys have access to their project's repositories and manage authentication credentials programmatically. summary: Atlassian List Project Deploy Keys responses: '200': description: Deploy keys matching the project content: application/json: schema: $ref: '#/components/schemas/paginated_project_deploy_keys' examples: paginated-project-deploy-keys: $ref: '#/components/examples/paginated-project-deploy-keys' '403': description: If the specified workspace or project is not accessible to the current user content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the specified workspace or project does not exist content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - project - project:admin - basic: [] - api_key: [] operationId: atlassianListProjectDeployKeys x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/projects/{project_key}/permissions-config/groups: parameters: - name: project_key in: path description: 'The project in question. This is the actual key assigned to the project. ' required: true schema: type: string - name: workspace in: path description: 'This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. ' required: true schema: type: string get: tags: - Lists description: This API endpoint retrieves a paginated list of explicit group permissions that have been directly granted to groups for a specific project within a Bitbucket workspace. By making a GET request to this endpoint with the workspace identifier and project key as path parameters, you can view all groups that have been explicitly assigned permissions to the project, along with their corresponding permission levels. This is useful for auditing access control, understanding who has what level of access to a project, and managing team permissions. The response excludes inherited permissions and only shows permissions that have been directly configured at the project level for groups, making it easier to track and manage explicit access grants without the noise of inherited permissions from workspace-level settings. summary: Atlassian List Explicit Group Permissions for a Project responses: '200': description: Paginated list of project group permissions content: application/json: schema: $ref: '#/components/schemas/paginated_project_group_permissions' examples: paginated-project-group-permissions: $ref: '#/components/examples/paginated-project-group-permissions' '401': description: The user couldn't be authenticated. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: The user doesn't have admin access to the project. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: One or both of the workspace and project don't exist for the given identifiers or the requesting user is not authenticated content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - project:admin - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:project:bitbucket - read:user:bitbucket operationId: atlassianListExplicitGroupPermissionsForAProject x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: ssh_account_key: allOf: - $ref: '#/components/schemas/ssh_key' - type: object title: SSH Account Key description: Represents an SSH public key for a user. properties: owner: $ref: '#/components/schemas/account' additionalProperties: true paginated_tasks: type: object title: Paginated Tasks description: A paginated list of tasks. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/A_pullrequest_comment_task' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_pullrequests: type: object title: Paginated Pull Requests description: A paginated list of pullrequests. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/pullrequest' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_deployments: type: object title: Paginated Deployments description: A paged list of deployments properties: page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. example: 10 values: type: array minItems: 0 items: $ref: '#/components/schemas/deployment' description: The values of the current page. example: [] size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. example: 10 next: type: string format: uri description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com previous: type: string format: uri description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com project_group_permission: type: object title: Project Group Permission description: A group's permission for a given project. properties: type: type: string example: example_value links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false example: example_value permission: type: string enum: - read - write - create-repo - admin - none example: read group: $ref: '#/components/schemas/group' project: $ref: '#/components/schemas/project' required: - type additionalProperties: true pipeline_target: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Target description: A representation of the target that a pipeline executes on. properties: {} paginated_deploy_keys: type: object title: Paginated Deploy Keys description: A paginated list of deploy keys. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/deploy_key' minItems: 0 uniqueItems: true example: [] additionalProperties: false pipeline_cache: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Cache description: A representation of metadata for a pipeline cache for given repository. properties: uuid: type: string description: The UUID identifying the pipeline cache. pipeline_uuid: type: string description: The UUID of the pipeline that created the cache. step_uuid: type: string description: The uuid of the step that created the cache. name: type: string description: The name of the cache. key_hash: type: string description: The key hash of the cache version. path: type: string description: The path where the cache contents were retrieved from. file_size_bytes: type: integer description: The size of the file containing the archive of the cache. created_on: type: string format: date-time description: The timestamp when the cache was created. paginated_snippets: type: object title: Paginated Snippets description: A paginated list of snippets. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: object title: Snippet description: A snippet object. properties: id: type: integer minimum: 0 title: type: string scm: type: string description: The DVCS used to store the snippet. enum: - git created_on: type: string format: date-time updated_on: type: string format: date-time owner: $ref: '#/components/schemas/account' creator: $ref: '#/components/schemas/account' is_private: type: boolean additionalProperties: true example: example_value additionalProperties: false paginated_refs: type: object title: Paginated Refs description: A paginated list of refs. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/ref' minItems: 0 uniqueItems: true example: [] additionalProperties: false workspace: allOf: - $ref: '#/components/schemas/object' - type: object title: Workspace description: "A Bitbucket workspace.\n Workspaces are used to organize repositories." properties: links: type: object properties: avatar: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false members: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false owners: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false projects: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false repositories: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false snippets: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false uuid: type: string description: The workspace's immutable id. name: type: string description: The name of the workspace. slug: type: string description: The short label that identifies this workspace. is_private: type: boolean description: 'Indicates whether the workspace is publicly accessible, or whether it is private to the members and consequently only visible to members.' created_on: type: string format: date-time updated_on: type: string format: date-time additionalProperties: true deployment_environment: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Deployment Environment description: A Bitbucket Deployment Environment. properties: uuid: type: string description: The UUID identifying the environment. name: type: string description: The name of the environment. x-bb-default-fields: - uuid x-bb-url: /rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments/{uuid} x-bb-batch-url: /rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/environments_batch x-bb-batch-max-size: 100 repository_user_permission: type: object title: Repository User Permission description: A user's direct permission for a given repository. properties: type: type: string example: example_value permission: type: string enum: - read - write - admin - none example: read user: $ref: '#/components/schemas/user' repository: $ref: '#/components/schemas/repository' links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false example: example_value required: - type additionalProperties: true issue_attachment: allOf: - $ref: '#/components/schemas/object' - type: object title: Issue Attachment description: An issue file attachment's meta data. Note this does not contain the file's actual contents. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false name: type: string additionalProperties: true comment_resolution: type: object title: Comment Resolution description: The resolution object for a Comment. properties: type: type: string example: example_value user: $ref: '#/components/schemas/account' created_on: type: string description: The ISO8601 timestamp the resolution was created. format: date-time example: '2026-01-15T10:30:00Z' required: - type additionalProperties: true pipeline_trigger: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Trigger description: A representation of the trigger used for a pipeline. properties: {} object: type: object description: Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`. properties: type: type: string example: example_value required: - type additionalProperties: true discriminator: propertyName: type paginated_milestones: type: object title: Paginated Milestones description: A paginated list of issue tracker milestones. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/milestone' minItems: 0 uniqueItems: true example: [] additionalProperties: false ssh_key: allOf: - $ref: '#/components/schemas/object' - type: object title: SSH Key description: Base type for representing SSH public keys. properties: uuid: type: string description: The SSH key's immutable ID. key: type: string description: The SSH public key value in OpenSSH format. comment: type: string description: The comment parsed from the SSH key (if present) label: type: string description: The user-defined label for the SSH key created_on: type: string format: date-time last_used: type: string format: date-time links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false additionalProperties: true paginated_projects: type: object title: Paginated Projects description: A paginated list of projects properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/project' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_changeset: type: object title: Page description: A paginated list of commits. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/base_commit' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_log_entries: type: object title: Paginated Log Entries description: A paginated list of issue changes. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/issue_change' minItems: 0 example: [] additionalProperties: false paginated_project_deploy_keys: type: object title: Paginated Project Deploy Keys description: A paginated list of project deploy keys. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/project_deploy_key' minItems: 0 uniqueItems: true example: [] additionalProperties: false link: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri example: https://www.example.com name: type: string example: Example Title additionalProperties: false pipeline_schedule_execution: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Schedule Execution description: A Pipelines schedule execution. properties: {} paginated_deployment_variable: type: object title: Paginated Deployment Variables description: A paged list of deployment variables. properties: page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. example: 10 values: type: array minItems: 0 items: $ref: '#/components/schemas/deployment_variable' description: The values of the current page. example: [] size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. example: 10 next: type: string format: uri description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com previous: type: string format: uri description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com paginated_issue_attachments: type: object title: Paginated Issue Attachment description: A paginated list of issue attachments. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/issue_attachment' minItems: 0 example: [] additionalProperties: false branchrestriction: allOf: - $ref: '#/components/schemas/object' - type: object title: Branch Restriction description: A branch restriction rule. properties: users: type: array items: $ref: '#/components/schemas/account' minItems: 0 groups: type: array items: $ref: '#/components/schemas/group' minItems: 0 additionalProperties: true commit: allOf: - $ref: '#/components/schemas/base_commit' - type: object title: Commit description: A repository commit object. properties: repository: $ref: '#/components/schemas/repository' participants: type: array items: $ref: '#/components/schemas/participant' minItems: 0 additionalProperties: true pipeline_schedule: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Schedule description: A Pipelines schedule. properties: uuid: type: string description: The UUID identifying the schedule. enabled: type: boolean description: Whether the schedule is enabled. target: $ref: '#/components/schemas/pipeline_ref_target' cron_pattern: type: string description: 'The cron expression with second precision (7 fields) that the schedule applies. For example, for expression: 0 0 12 * * ? *, will execute at 12pm UTC every day.' created_on: type: string format: date-time description: The timestamp when the schedule was created. updated_on: type: string format: date-time description: The timestamp when the schedule was updated. paginated_tags: type: object title: Paginated Tags description: A paginated list of tags. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/tag' minItems: 0 uniqueItems: true example: [] additionalProperties: false deploy_key: allOf: - $ref: '#/components/schemas/object' - type: object title: Deploy Key description: Represents deploy key for a repository. properties: key: type: string description: The deploy key value. repository: $ref: '#/components/schemas/repository' comment: type: string description: The comment parsed from the deploy key (if present) label: type: string description: The user-defined label for the deploy key added_on: type: string format: date-time last_used: type: string format: date-time links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false owner: $ref: '#/components/schemas/account' additionalProperties: true issue_comment: allOf: - $ref: '#/components/schemas/comment' - type: object title: Issue Comment description: A issue comment. properties: issue: $ref: '#/components/schemas/issue' additionalProperties: true paginated_repository_permissions: type: object title: Paginated Repository Permissions description: A paginated list of repository permissions. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/repository_permission' minItems: 0 uniqueItems: true example: [] additionalProperties: false pipeline: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline description: A Bitbucket Pipeline. This represents an actual pipeline result. properties: uuid: type: string description: The UUID identifying the pipeline. build_number: type: integer description: The build number of the pipeline. creator: $ref: '#/components/schemas/account' repository: $ref: '#/components/schemas/repository' target: $ref: '#/components/schemas/pipeline_target' trigger: $ref: '#/components/schemas/pipeline_trigger' state: $ref: '#/components/schemas/pipeline_state' variables: type: array minItems: 0 items: $ref: '#/components/schemas/pipeline_variable' description: The variables for the pipeline. created_on: type: string format: date-time description: The timestamp when the pipeline was created. completed_on: type: string format: date-time description: The timestamp when the Pipeline was completed. This is not set if the pipeline is still in progress. build_seconds_used: type: integer description: The number of build seconds used by this pipeline. account: allOf: - $ref: '#/components/schemas/object' - type: object title: Account description: An account object. properties: links: $ref: '#/components/schemas/account_links' created_on: type: string format: date-time display_name: type: string username: type: string pattern: ^[a-zA-Z0-9_\-]+$ uuid: type: string additionalProperties: true participant: allOf: - $ref: '#/components/schemas/object' - type: object title: Participant description: Object describing a user's role on resources like commits or pull requests. properties: user: $ref: '#/components/schemas/account' role: type: string enum: - PARTICIPANT - REVIEWER approved: type: boolean state: type: string enum: - approved - changes_requested - null participated_on: type: string description: The ISO8601 timestamp of the participant's action. For approvers, this is the time of their approval. For commenters and pull request reviewers who are not approvers, this is the time they last commented, or null if they have not commented. format: date-time additionalProperties: true paginated_versions: type: object title: Paginated Versions description: A paginated list of issue tracker versions. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/version' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_ssh_user_keys: type: object title: Paginated SSH User Keys description: A paginated list of SSH keys. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/ssh_account_key' minItems: 0 uniqueItems: true example: [] additionalProperties: false A_pull_request_task: allOf: - $ref: '#/components/schemas/task' - type: object title: Pull Request Task description: A pull request task. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false additionalProperties: false pipeline_image: type: object title: Pipeline Image description: The definition of a Docker image that can be used for a Bitbucket Pipelines step execution context. properties: name: type: string description: The name of the image. If the image is hosted on DockerHub the short name can be used, otherwise the fully qualified name is required here. example: Example Title username: type: string description: The username needed to authenticate with the Docker registry. Only required when using a private Docker image. example: example_value password: type: string description: The password needed to authenticate with the Docker registry. Only required when using a private Docker image. example: example_value email: type: string description: The email needed to authenticate with the Docker registry. Only required when using a private Docker image. example: user@example.com pullrequest_endpoint: type: object title: Pull Request Endpoint properties: repository: $ref: '#/components/schemas/repository' branch: type: object title: Pull Request Branch properties: name: type: string merge_strategies: type: array description: Available merge strategies, when this endpoint is the destination of the pull request. items: type: string enum: - merge_commit - squash - fast_forward default_merge_strategy: type: string description: The default merge strategy, when this endpoint is the destination of the pull request. additionalProperties: false example: example_value commit: type: object title: Pull Request Commit properties: hash: type: string pattern: '[0-9a-f]{7,}?' additionalProperties: false example: example_value additionalProperties: false workspace_membership: allOf: - $ref: '#/components/schemas/object' - type: object title: Workspace Membership description: "A Bitbucket workspace membership.\n Links a user to a workspace." properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false user: $ref: '#/components/schemas/account' workspace: $ref: '#/components/schemas/workspace' additionalProperties: true paginated_pipeline_schedule_executions: type: object title: Paginated Pipeline Schedule Executions description: A paged list of the executions of a schedule. properties: page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. example: 10 values: type: array minItems: 0 items: $ref: '#/components/schemas/pipeline_schedule_execution' description: The values of the current page. example: [] size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. example: 10 next: type: string format: uri description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com previous: type: string format: uri description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com paginated_accounts: type: object title: Paginated Accounts description: A paginated list of accounts. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/account' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_repository_user_permissions: type: object title: Paginated Repository User Permissions description: A paginated list of repository user permissions. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/repository_user_permission' minItems: 0 uniqueItems: true example: [] additionalProperties: false tag: allOf: - $ref: '#/components/schemas/ref' - type: object title: Tag description: A tag object, representing a tag in a repository. properties: message: type: string description: The message associated with the tag, if available. date: type: string description: The date that the tag was created, if available format: date-time tagger: $ref: '#/components/schemas/author' additionalProperties: true paginated_components: type: object title: Paginated Components description: A paginated list of issue tracker components. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/component' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_branchrestrictions: type: object title: Paginated Branch Restrictions description: A paginated list of branch restriction rules. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/branchrestriction' minItems: 0 uniqueItems: true example: [] additionalProperties: false comment: allOf: - $ref: '#/components/schemas/object' - type: object title: Comment description: The base type for all comments. This type should be considered abstract. Each of the "commentable" resources defines its own subtypes (e.g. `issue_comment`). properties: id: type: integer created_on: type: string format: date-time updated_on: type: string format: date-time content: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false user: $ref: '#/components/schemas/account' deleted: type: boolean parent: $ref: '#/components/schemas/comment' inline: type: object properties: from: type: integer description: The comment's anchor line in the old version of the file. minimum: 1 to: type: integer description: The comment's anchor line in the new version of the file. If the 'from' line is also provided, this value will be removed. minimum: 1 path: type: string description: The path of the file this comment is anchored to. required: - path additionalProperties: false links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false code: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false additionalProperties: true repository: allOf: - $ref: '#/components/schemas/object' - type: object title: Repository description: A Bitbucket repository. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false avatar: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false pullrequests: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false commits: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false forks: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false watchers: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false downloads: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false clone: type: array items: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false hooks: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false uuid: type: string description: The repository's immutable id. This can be used as a substitute for the slug segment in URLs. Doing this guarantees your URLs will survive renaming of the repository by its owner, or even transfer of the repository to a different user. full_name: type: string description: The concatenation of the repository owner's username and the slugified name, e.g. "evzijst/interruptingcow". This is the same string used in Bitbucket URLs. is_private: type: boolean parent: $ref: '#/components/schemas/repository' scm: type: string enum: - git owner: $ref: '#/components/schemas/account' name: type: string description: type: string created_on: type: string format: date-time updated_on: type: string format: date-time size: type: integer language: type: string has_issues: type: boolean description: ' The issue tracker for this repository is enabled. Issue Tracker features are not supported for repositories in workspaces administered through admin.atlassian.com. ' has_wiki: type: boolean description: ' The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com. ' fork_policy: type: string description: "\nControls the rules for forking this repository.\n\n* **allow_forks**: unrestricted forking\n* **no_public_forks**: restrict forking to private forks (forks cannot\n be made public later)\n* **no_forks**: deny all forking\n" enum: - allow_forks - no_public_forks - no_forks project: $ref: '#/components/schemas/project' mainbranch: $ref: '#/components/schemas/branch' additionalProperties: true commit_comment: allOf: - $ref: '#/components/schemas/comment' - type: object title: Commit Comment description: A commit comment. properties: commit: $ref: '#/components/schemas/commit' additionalProperties: true commit_file: type: object title: Commit File description: A file object, representing a file at a commit in a repository properties: type: type: string example: example_value path: type: string description: The path in the repository example: example_value commit: $ref: '#/components/schemas/commit' attributes: type: string enum: - link - executable - subrepository - binary - lfs example: link escaped_path: type: string description: The escaped version of the path as it appears in a diff. If the path does not require escaping this will be the same as path. example: example_value required: - type additionalProperties: true pipeline_command: type: object title: Pipeline Command description: An executable pipeline command. properties: name: type: string description: The name of the command. example: Example Title command: type: string description: The executable command. example: example_value issue_change: type: object title: Issue Change description: An issue change. properties: type: type: string example: example_value links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false issue: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false example: example_value name: type: string example: Example Title created_on: type: string format: date-time example: '2026-01-15T10:30:00Z' user: $ref: '#/components/schemas/account' issue: $ref: '#/components/schemas/issue' changes: type: object properties: assignee: type: object properties: old: type: string new: type: string additionalProperties: false state: type: object properties: old: type: string new: type: string additionalProperties: false title: type: object properties: old: type: string new: type: string additionalProperties: false kind: type: object properties: old: type: string new: type: string additionalProperties: false milestone: type: object properties: old: type: string new: type: string additionalProperties: false component: type: object properties: old: type: string new: type: string additionalProperties: false priority: type: object properties: old: type: string new: type: string additionalProperties: false version: type: object properties: old: type: string new: type: string additionalProperties: false content: type: object properties: old: type: string new: type: string additionalProperties: false additionalProperties: false example: example_value message: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false example: example_value required: - type additionalProperties: true paginated_branches: type: object title: Paginated Branches description: A paginated list of branches. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/branch' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_pipeline_schedules: type: object title: Paginated Pipeline Schedule description: A paged list of schedules properties: page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. example: 10 values: type: array minItems: 0 items: $ref: '#/components/schemas/pipeline_schedule' description: The values of the current page. example: [] size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. example: 10 next: type: string format: uri description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com previous: type: string format: uri description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com pipeline_selector: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Selector description: A representation of the selector that was used to identify the pipeline in the YML file. properties: type: enum: - branches - tags - bookmarks - default - custom type: string description: The type of selector. pattern: type: string description: The name of the matching pipeline definition. repository_group_permission: type: object title: Repository Group Permission description: A group's permission for a given repository. properties: type: type: string example: example_value links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false example: example_value permission: type: string enum: - read - write - admin - none example: read group: $ref: '#/components/schemas/group' repository: $ref: '#/components/schemas/repository' required: - type additionalProperties: true task: type: object title: Task description: A task object. properties: id: type: integer example: abc123 created_on: type: string format: date-time example: '2026-01-15T10:30:00Z' updated_on: type: string format: date-time example: '2026-01-15T10:30:00Z' state: type: string enum: - RESOLVED - UNRESOLVED example: RESOLVED content: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false example: example_value creator: $ref: '#/components/schemas/account' pending: type: boolean example: true resolved_on: type: string description: The ISO8601 timestamp for when the task was resolved. format: date-time example: '2026-01-15T10:30:00Z' resolved_by: $ref: '#/components/schemas/account' required: - created_on - updated_on - state - content - creator additionalProperties: false paginated_reports: type: object title: Paginated Reports description: A paginated list of reports. properties: page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. example: 10 values: type: array minItems: 0 items: $ref: '#/components/schemas/report' description: The values of the current page. example: [] size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. example: 10 next: type: string format: uri description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com previous: type: string format: uri description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com paginated_pipeline_steps: type: object title: Paginated Pipeline Steps description: A paged list of pipeline steps. properties: page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. example: 10 values: type: array minItems: 0 items: $ref: '#/components/schemas/pipeline_step' description: The values of the current page. example: [] size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. example: 10 next: type: string format: uri description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com previous: type: string format: uri description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com pipeline_state: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline State description: The representation of the progress state of a pipeline. properties: {} paginated_repositories: type: object title: Paginated Repositories description: A paginated list of repositories. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/repository' minItems: 0 uniqueItems: true example: [] additionalProperties: false report: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Commit Report description: A report for a commit. properties: uuid: type: string description: The UUID that can be used to identify the report. title: type: string description: The title of the report. details: type: string description: A string to describe the purpose of the report. external_id: type: string description: ID of the report provided by the report creator. It can be used to identify the report as an alternative to it's generated uuid. It is not used by Bitbucket, but only by the report creator for updating or deleting this specific report. Needs to be unique. reporter: type: string description: A string to describe the tool or company who created the report. link: type: string format: uri description: A URL linking to the results of the report in an external tool. remote_link_enabled: type: boolean description: If enabled, a remote link is created in Jira for the issue associated with the commit the report belongs to. logo_url: type: string format: uri description: A URL to the report logo. If none is provided, the default insights logo will be used. report_type: enum: - SECURITY - COVERAGE - TEST - BUG type: string description: The type of the report. result: enum: - PASSED - FAILED - PENDING type: string description: The state of the report. May be set to PENDING and later updated. data: type: array items: $ref: '#/components/schemas/report_data' description: An array of data fields to display information on the report. Maximum 10. created_on: type: string format: date-time description: The timestamp when the report was created. updated_on: type: string format: date-time description: The timestamp when the report was updated. x-bb-default-fields: - uuid - commitHash x-bb-url: /rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/commits/{commitHash}/reports/{uuid} deployment_release: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Deployment Release description: A Bitbucket Deployment Release. properties: uuid: type: string description: The UUID identifying the release. name: type: string description: The name of the release. url: type: string format: uri description: Link to the pipeline that produced the release. commit: $ref: '#/components/schemas/commit' created_on: type: string format: date-time description: The timestamp when the release was created. paginated_repository_group_permissions: type: object title: Paginated Repository Group Permissions description: A paginated list of repository group permissions. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/repository_group_permission' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_accounts_2: type: object title: Paginated Accounts description: A paginated list of accounts. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: object title: Account description: An account object. properties: links: $ref: '#/components/schemas/account_links' created_on: type: string format: date-time display_name: type: string username: type: string pattern: ^[a-zA-Z0-9_\-]+$ uuid: type: string additionalProperties: true example: example_value additionalProperties: false error: type: object title: Error description: Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`. properties: type: type: string example: example_value error: type: object properties: message: type: string detail: type: string data: type: object description: Optional structured data that is endpoint-specific. properties: {} additionalProperties: true required: - message additionalProperties: false example: example_value required: - type additionalProperties: true group: allOf: - $ref: '#/components/schemas/object' - type: object title: Group description: A group object properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false owner: $ref: '#/components/schemas/account' workspace: $ref: '#/components/schemas/workspace' name: type: string slug: type: string description: 'The "sluggified" version of the group''s name. This contains only ASCII characters and can therefore be slightly different than the name' full_slug: type: string description: 'The concatenation of the workspace''s slug and the group''s slug, separated with a colon (e.g. `acme:developers`) ' additionalProperties: true commitstatus: allOf: - $ref: '#/components/schemas/object' - type: object title: Commit Status description: A commit status object. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false commit: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false uuid: type: string description: The commit status' id. key: type: string description: "An identifier for the status that's unique to\n its type (current \"build\" is the only supported type) and the vendor,\n e.g. BB-DEPLOY" refname: type: string description: ' The name of the ref that pointed to this commit at the time the status object was created. Note that this the ref may since have moved off of the commit. This optional field can be useful for build systems whose build triggers and configuration are branch-dependent (e.g. a Pipeline build). It is legitimate for this field to not be set, or even apply (e.g. a static linting job).' url: type: string description: A URL linking back to the vendor or build system, for providing more information about whatever process produced this status. Accepts context variables `repository` and `commit` that Bitbucket will evaluate at runtime whenever at runtime. For example, one could use https://foo.com/builds/{repository.full_name} which Bitbucket will turn into https://foo.com/builds/foo/bar at render time. state: type: string description: Provides some indication of the status of this commit enum: - INPROGRESS - FAILED - STOPPED - SUCCESSFUL name: type: string description: An identifier for the build itself, e.g. BB-DEPLOY-1 description: type: string description: A description of the build (e.g. "Unit tests in Bamboo") created_on: type: string format: date-time updated_on: type: string format: date-time additionalProperties: true paginated_commit_comments: type: object title: Paginated Commit Comments description: A paginated list of commit comments. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/commit_comment' minItems: 0 uniqueItems: true example: [] additionalProperties: false component: allOf: - $ref: '#/components/schemas/object' - type: object title: Component description: A component as defined in a repository's issue tracker. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false name: type: string id: type: integer additionalProperties: true deployment_variable: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Deployment Variable description: A Pipelines deployment variable. properties: uuid: type: string description: The UUID identifying the variable. key: type: string description: The unique name of the variable. value: type: string description: The value of the variable. If the variable is secured, this will be empty. secured: type: boolean description: If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API. paginated_webhook_subscriptions: type: object title: Paginated Webhook Subscriptions description: A paginated list of webhook subscriptions properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/webhook_subscription' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_pipeline_caches: type: object title: Paginated Pipeline Cache description: A paged list of pipeline caches properties: page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. example: 10 values: type: array minItems: 0 items: $ref: '#/components/schemas/pipeline_cache' description: The values of the current page. example: [] size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. example: 10 next: type: string format: uri description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com previous: type: string format: uri description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com account_links: type: object title: Account Links description: Links related to an Account. properties: avatar: $ref: '#/components/schemas/link' additionalProperties: true pipeline_known_host: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Known Host description: A Pipelines known host. properties: uuid: type: string description: The UUID identifying the known host. hostname: type: string description: The hostname of the known host. public_key: $ref: '#/components/schemas/pipeline_ssh_public_key' paginated_issue_comments: type: object title: Paginated Issue Comments description: A paginated list of issue comments. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/issue_comment' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_pipeline_known_hosts: type: object title: Paginated Pipeline Known Hosts description: A paged list of known hosts. properties: page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. example: 10 values: type: array minItems: 0 items: $ref: '#/components/schemas/pipeline_known_host' description: The values of the current page. example: [] size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. example: 10 next: type: string format: uri description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com previous: type: string format: uri description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com deployment_state: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Deployment State description: The representation of the progress state of a deployment. properties: {} base_commit: allOf: - $ref: '#/components/schemas/object' - type: object title: Base Commit description: The common base type for both repository and snippet commits. properties: hash: type: string pattern: '[0-9a-f]{7,}?' date: type: string format: date-time author: $ref: '#/components/schemas/author' message: type: string summary: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false parents: type: array items: $ref: '#/components/schemas/base_commit' minItems: 0 additionalProperties: true paginated_issues: type: object title: Paginated Issues description: A paginated list of issues. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/issue' minItems: 0 uniqueItems: true example: [] additionalProperties: false webhook_subscription: allOf: - $ref: '#/components/schemas/object' - type: object title: Webhook Subscription description: A Webhook subscription. properties: uuid: type: string description: The webhook's id url: type: string description: The URL events get delivered to. format: uri description: type: string description: A user-defined description of the webhook. subject_type: type: string description: The type of entity. Set to either `repository` or `workspace` based on where the subscription is defined. enum: - repository - workspace subject: $ref: '#/components/schemas/object' active: type: boolean created_at: type: string format: date-time events: type: array description: The events this webhook is subscribed to. items: type: string enum: - pullrequest:comment_reopened - pullrequest:approved - issue:comment_created - repo:push - pullrequest:comment_deleted - pullrequest:fulfilled - pullrequest:comment_created - pullrequest:comment_updated - pullrequest:updated - repo:commit_status_created - pullrequest:unapproved - repo:updated - pullrequest:comment_resolved - repo:transfer - repo:commit_status_updated - pullrequest:changes_request_created - issue:updated - repo:created - pullrequest:changes_request_removed - pullrequest:rejected - pullrequest:created - issue:created - repo:imported - repo:commit_comment_created - project:updated - repo:fork - repo:deleted minItems: 1 uniqueItems: true secret_set: type: boolean description: Indicates whether or not the hook has an associated secret. It is not possible to see the hook's secret. This field is ignored during updates. secret: type: string description: The secret to associate with the hook. The secret is never returned via the API. As such, this field is only used during updates. The secret can be set to `null` or "" to remove the secret (or create a hook with no secret). Leaving out the secret field during updates will leave the secret unchanged. Leaving out the secret during creation will create a hook with no secret. minLength: 0 maxLength: 128 additionalProperties: true branch: allOf: - $ref: '#/components/schemas/ref' - type: object title: Branch description: A branch object, representing a branch in a repository. properties: merge_strategies: type: array description: Available merge strategies for pull requests targeting this branch. items: type: string enum: - merge_commit - squash - fast_forward default_merge_strategy: type: string description: The default merge strategy for pull requests targeting this branch. additionalProperties: true project_user_permission: type: object title: Project User Permission description: A user's direct permission for a given project. properties: type: type: string example: example_value links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false example: example_value permission: type: string enum: - read - write - create-repo - admin - none example: read user: $ref: '#/components/schemas/user' project: $ref: '#/components/schemas/project' required: - type additionalProperties: true paginated_project_group_permissions: type: object title: Paginated Project Group Permissions description: A paginated list of project group permissions. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/project_group_permission' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_default_reviewer_and_type: type: object title: Paginated Default Reviewer and Type description: A paginated list of default reviewers with reviewer type. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/default_reviewer_and_type' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_project_user_permissions: type: object title: Paginated Project User Permissions description: A paginated list of project user permissions. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/project_user_permission' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_workspace_memberships: type: object title: Paginated Workspace Memberships description: A paginated list of workspace memberships. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/workspace_membership' minItems: 0 uniqueItems: true example: [] additionalProperties: false milestone: allOf: - $ref: '#/components/schemas/object' - type: object title: Milestone description: A milestone as defined in a repository's issue tracker. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false name: type: string id: type: integer additionalProperties: true paginated_annotations: type: object title: Paginated Annotations description: A paginated list of annotations. properties: page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. example: 10 values: type: array minItems: 0 items: $ref: '#/components/schemas/report_annotation' description: The values of the current page. example: [] size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. example: 10 next: type: string format: uri description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com previous: type: string format: uri description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com paginated_pullrequest_comments: type: object title: Paginated Pull Request Comments description: A paginated list of pullrequest comments. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/pullrequest_comment' minItems: 0 uniqueItems: true example: [] additionalProperties: false user: allOf: - $ref: '#/components/schemas/account' - type: object title: User description: A user object. properties: links: $ref: '#/components/schemas/user_links' account_id: type: string description: The user's Atlassian account ID. account_status: type: string description: The status of the account. Currently the only possible value is "active", but more values may be added in the future. has_2fa_enabled: type: boolean nickname: type: string description: Account name defined by the owner. Should be used instead of the "username" field. Note that "nickname" cannot be used in place of "username" in URLs and queries, as "nickname" is not guaranteed to be unique. is_staff: type: boolean website: type: string additionalProperties: true ref: type: object title: Ref description: A ref object, representing a branch or tag in a repository. properties: type: type: string example: example_value links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false commits: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false example: example_value name: type: string description: The name of the ref. example: Example Title target: $ref: '#/components/schemas/commit' required: - type additionalProperties: true pipeline_ref_target: allOf: - $ref: '#/components/schemas/pipeline_target' - additionalProperties: true type: object title: Pipeline Ref Target description: A Bitbucket Pipelines reference target. properties: ref_type: enum: - branch - tag - named_branch - bookmark type: string description: The type of reference (branch/tag). ref_name: type: string description: The name of the reference. commit: $ref: '#/components/schemas/commit' selector: $ref: '#/components/schemas/pipeline_selector' team_links: allOf: - $ref: '#/components/schemas/account_links' - type: object title: Team Links description: Links related to a Team. properties: self: $ref: '#/components/schemas/link' html: $ref: '#/components/schemas/link' members: $ref: '#/components/schemas/link' projects: $ref: '#/components/schemas/link' repositories: $ref: '#/components/schemas/link' additionalProperties: true project: allOf: - $ref: '#/components/schemas/object' - type: object title: Project description: "A Bitbucket project.\n Projects are used by teams to organize repositories." properties: links: type: object properties: html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false avatar: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false uuid: type: string description: The project's immutable id. key: type: string description: The project's key. owner: $ref: '#/components/schemas/team' name: type: string description: The name of the project. description: type: string is_private: type: boolean description: ' 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.' created_on: type: string format: date-time updated_on: type: string format: date-time has_publicly_visible_repos: type: boolean description: ' Indicates whether the project contains publicly visible repositories. Note that private projects cannot contain public repositories.' additionalProperties: true A_pullrequest_comment_task: allOf: - $ref: '#/components/schemas/A_pull_request_task' - type: object title: Pull Request Comment Task description: A pullrequest comment task properties: comment: $ref: '#/components/schemas/comment' additionalProperties: false issue: allOf: - $ref: '#/components/schemas/object' - type: object title: Issue description: An issue. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false comments: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false attachments: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false watch: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false vote: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false id: type: integer repository: $ref: '#/components/schemas/repository' title: type: string reporter: $ref: '#/components/schemas/account' assignee: $ref: '#/components/schemas/account' created_on: type: string format: date-time updated_on: type: string format: date-time edited_on: type: string format: date-time state: type: string enum: - submitted - new - open - resolved - on hold - invalid - duplicate - wontfix - closed kind: type: string enum: - bug - enhancement - proposal - task priority: type: string enum: - trivial - minor - major - critical - blocker milestone: $ref: '#/components/schemas/milestone' version: $ref: '#/components/schemas/version' component: $ref: '#/components/schemas/component' votes: type: integer content: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false additionalProperties: true paginated_pipeline_variables: type: object title: Paginated Pipeline Variables description: A paged list of variables. properties: page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. example: 10 values: type: array minItems: 0 items: $ref: '#/components/schemas/pipeline_variable' description: The values of the current page. example: [] size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. example: 10 next: type: string format: uri description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com previous: type: string format: uri description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com pullrequest: allOf: - $ref: '#/components/schemas/object' - type: object title: Pull Request description: A pull request object. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false commits: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false approve: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false diff: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false diffstat: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false comments: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false activity: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false merge: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false decline: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false id: type: integer description: The pull request's unique ID. Note that pull request IDs are only unique within their associated repository. title: type: string description: Title of the pull request. rendered: type: object title: Rendered Pull Request Markup description: User provided pull request text, interpreted in a markup language and rendered in HTML properties: title: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false description: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false reason: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false additionalProperties: false summary: type: object properties: raw: type: string description: The text as it was typed by a user. markup: type: string description: The type of markup language the raw content is to be interpreted in. enum: - markdown - creole - plaintext html: type: string description: The user's content rendered as HTML. additionalProperties: false state: type: string description: The pull request's current status. enum: - OPEN - MERGED - DECLINED - SUPERSEDED author: $ref: '#/components/schemas/account' source: $ref: '#/components/schemas/pullrequest_endpoint' destination: $ref: '#/components/schemas/pullrequest_endpoint' merge_commit: type: object title: Pull Request Commit properties: hash: type: string pattern: '[0-9a-f]{7,}?' additionalProperties: false comment_count: type: integer description: The number of comments for a specific pull request. minimum: 0 task_count: type: integer description: The number of open tasks for a specific pull request. minimum: 0 close_source_branch: type: boolean description: A boolean flag indicating if merging the pull request closes the source branch. closed_by: $ref: '#/components/schemas/account' reason: type: string description: Explains why a pull request was declined. This field is only applicable to pull requests in rejected state. created_on: type: string description: The ISO8601 timestamp the request was created. format: date-time updated_on: type: string description: The ISO8601 timestamp the request was last updated. format: date-time reviewers: type: array description: The list of users that were added as reviewers on this pull request when it was created. For performance reasons, the API only includes this list on a pull request's `self` URL. items: $ref: '#/components/schemas/account' participants: type: array description: " The list of users that are collaborating on this pull request.\n Collaborators are user that:\n\n * are added to the pull request as a reviewer (part of the reviewers\n list)\n * are not explicit reviewers, but have commented on the pull request\n * are not explicit reviewers, but have approved the pull request\n\n Each user is wrapped in an object that indicates the user's role and\n whether they have approved the pull request. For performance reasons,\n the API only returns this list when an API requests a pull request by\n id.\n " items: $ref: '#/components/schemas/participant' additionalProperties: true author: allOf: - $ref: '#/components/schemas/object' - type: object title: Author description: The author of a change in a repository properties: raw: type: string description: The raw author value from the repository. This may be the only value available if the author does not match a user in Bitbucket. user: $ref: '#/components/schemas/account' additionalProperties: true team: allOf: - $ref: '#/components/schemas/account' - type: object title: Team description: A team object. properties: links: $ref: '#/components/schemas/team_links' additionalProperties: true pipeline_step_state: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Step State description: The representation of the progress state of a pipeline step. properties: {} project_deploy_key: allOf: - $ref: '#/components/schemas/object' - type: object title: Project Deploy Key description: Represents deploy key for a project. properties: key: type: string description: The deploy key value. project: $ref: '#/components/schemas/project' comment: type: string description: The comment parsed from the deploy key (if present) label: type: string description: The user-defined label for the deploy key added_on: type: string format: date-time last_used: type: string format: date-time links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false created_by: $ref: '#/components/schemas/account' additionalProperties: true snippet: allOf: - $ref: '#/components/schemas/object' - type: object title: Snippet description: A snippet object. properties: id: type: integer minimum: 0 title: type: string scm: type: string description: The DVCS used to store the snippet. enum: - git created_on: type: string format: date-time updated_on: type: string format: date-time owner: $ref: '#/components/schemas/account' creator: $ref: '#/components/schemas/account' is_private: type: boolean additionalProperties: true report_annotation: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Report Annotation description: A report for a commit. properties: external_id: type: string description: ID of the annotation provided by the annotation creator. It can be used to identify the annotation as an alternative to it's generated uuid. It is not used by Bitbucket, but only by the annotation creator for updating or deleting this specific annotation. Needs to be unique. uuid: type: string description: The UUID that can be used to identify the annotation. annotation_type: enum: - VULNERABILITY - CODE_SMELL - BUG type: string description: The type of the report. path: type: string description: The path of the file on which this annotation should be placed. This is the path of the file relative to the git repository. If no path is provided, then it will appear in the overview modal on all pull requests where the tip of the branch is the given commit, regardless of which files were modified. line: type: integer description: The line number that the annotation should belong to. If no line number is provided, then it will default to 0 and in a pull request it will appear at the top of the file specified by the path field. minimum: 1 summary: type: string description: The message to display to users. details: type: string description: The details to show to users when clicking on the annotation. result: enum: - PASSED - FAILED - SKIPPED - IGNORED type: string description: The state of the report. May be set to PENDING and later updated. severity: enum: - CRITICAL - HIGH - MEDIUM - LOW type: string description: The severity of the annotation. link: type: string format: uri description: A URL linking to the annotation in an external tool. created_on: type: string format: date-time description: The timestamp when the report was created. updated_on: type: string format: date-time description: The timestamp when the report was updated. x-bb-default-fields: - uuid x-bb-url: /rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/commits/{commit.hash}/reports/{reportUuid}/annotations/{uuid} user_links: allOf: - $ref: '#/components/schemas/account_links' - type: object title: User Links description: Links related to a User. properties: self: $ref: '#/components/schemas/link' html: $ref: '#/components/schemas/link' repositories: $ref: '#/components/schemas/link' additionalProperties: true version: allOf: - $ref: '#/components/schemas/object' - type: object title: Version description: A version as defined in a repository's issue tracker. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false name: type: string id: type: integer additionalProperties: true paginated_hook_events: type: object title: Paginated Hook Events description: A paginated list of webhook types available to subscribe on. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/hook_event' minItems: 0 uniqueItems: true example: [] additionalProperties: false repository_permission: type: object title: Repository Permission description: A user's permission for a given repository. properties: type: type: string example: example_value permission: type: string enum: - read - write - admin - none example: read user: $ref: '#/components/schemas/user' repository: $ref: '#/components/schemas/repository' required: - type additionalProperties: true paginated_commitstatuses: type: object title: Paginated Commit Statuses description: A paginated list of commit status objects. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/commitstatus' minItems: 0 uniqueItems: true example: [] additionalProperties: false paginated_pipelines: type: object title: Paginated Pipelines description: A paged list of pipelines properties: page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. example: 10 values: type: array minItems: 0 items: $ref: '#/components/schemas/pipeline' description: The values of the current page. example: [] size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. example: 10 next: type: string format: uri description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com previous: type: string format: uri description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com deployment: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Deployment description: A Bitbucket Deployment. properties: uuid: type: string description: The UUID identifying the deployment. state: $ref: '#/components/schemas/deployment_state' environment: $ref: '#/components/schemas/deployment_environment' release: $ref: '#/components/schemas/deployment_release' paginated_environments: type: object title: Paginated Deployment Environments description: A paged list of environments properties: page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. example: 10 values: type: array minItems: 0 items: $ref: '#/components/schemas/deployment_environment' description: The values of the current page. example: [] size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. example: 10 next: type: string format: uri description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com previous: type: string format: uri description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. example: https://www.example.com report_data: type: object title: Report Data description: A key-value element that will be displayed along with the report. properties: type: enum: - BOOLEAN - DATE - DURATION - LINK - NUMBER - PERCENTAGE - TEXT type: string description: The type of data contained in the value field. If not provided, then the value will be detected as a boolean, number or string. example: BOOLEAN title: type: string description: A string describing what this data field represents. example: Example Title value: type: object description: The value of the data element. example: example_value pipeline_step: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Step description: A step of a Bitbucket pipeline. This represents the actual result of the step execution. properties: uuid: type: string description: The UUID identifying the step. started_on: type: string format: date-time description: The timestamp when the step execution was started. This is not set when the step hasn't executed yet. completed_on: type: string format: date-time description: The timestamp when the step execution was completed. This is not set if the step is still in progress. state: $ref: '#/components/schemas/pipeline_step_state' image: $ref: '#/components/schemas/pipeline_image' setup_commands: type: array items: $ref: '#/components/schemas/pipeline_command' description: The list of commands that are executed as part of the setup phase of the build. These commands are executed outside the build container. script_commands: type: array items: $ref: '#/components/schemas/pipeline_command' description: The list of build commands. These commands are executed in the build container. x-bb-default-fields: - uuid x-bb-url: /rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/{pipeline.uuid}/steps/{uuid} x-bb-batch-url: /rest/1.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/pipelines/steps_batch x-bb-batch-max-size: 100 pipeline_variable: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline Variable description: A Pipelines variable. properties: uuid: type: string description: The UUID identifying the variable. key: type: string description: The unique name of the variable. value: type: string description: The value of the variable. If the variable is secured, this will be empty. secured: type: boolean description: If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API. paginated_snippet_comments: type: object title: Paginated Snippet Comments description: A paginated list of snippet comments. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: object title: Snippet Comment description: A comment on a snippet. properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false snippet: $ref: '#/components/schemas/snippet' additionalProperties: true example: example_value additionalProperties: false pipeline_ssh_public_key: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline SSH Public Key description: A Pipelines known host public key. properties: key_type: type: string description: The type of the public key. key: type: string description: The base64 encoded public key. md5_fingerprint: type: string description: The MD5 fingerprint of the public key. sha256_fingerprint: type: string description: The SHA-256 fingerprint of the public key. paginated_snippet_commit: type: object title: Paginated Snippet Commits description: A paginated list of snippet commits. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: object title: Snippet Commit description: '' properties: links: type: object properties: self: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false html: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false diff: type: object title: Link description: A link to a resource related to this object. properties: href: type: string format: uri name: type: string additionalProperties: false additionalProperties: false snippet: $ref: '#/components/schemas/snippet' additionalProperties: true example: example_value additionalProperties: false paginated_files: type: object title: Paginated Files description: A paginated list of commit_file objects. properties: size: type: integer description: Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute. minimum: 0 example: 10 page: type: integer description: Page number of the current results. This is an optional element that is not provided in all responses. minimum: 1 example: 10 pagelen: type: integer description: Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values. minimum: 1 example: 10 next: type: string description: Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com previous: type: string description: Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs. format: uri example: https://www.example.com values: type: array items: $ref: '#/components/schemas/commit_file' minItems: 0 uniqueItems: true example: [] additionalProperties: false pullrequest_comment: allOf: - $ref: '#/components/schemas/comment' - type: object title: Pull Request Comment description: A pullrequest comment. properties: pullrequest: $ref: '#/components/schemas/pullrequest' resolution: $ref: '#/components/schemas/comment_resolution' pending: type: boolean additionalProperties: true default_reviewer_and_type: type: object title: Default Reviewer and Type description: Object containing a user that is a default reviewer and the type of reviewer properties: type: type: string example: example_value reviewer_type: type: string example: example_value user: $ref: '#/components/schemas/user' required: - type additionalProperties: true examples: paginated-log-entries: size: 42 page: 1 pagelen: 10 next: https://api.example.com/logs?page=2 previous: https://api.example.com/logs?page=0 values: [] paginated-accounts_2: size: 42 page: 1 pagelen: 10 next: https://api.example.com/accounts?page=2 previous: https://api.example.com/accounts?page=0 values: created_on: '2023-11-15T10:30:00Z' display_name: John Doe username: john_doe-123 uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 paginated-webhook-subscriptions: size: 25 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/workspaces/my-workspace/hooks?page=2 previous: https://api.bitbucket.org/2.0/workspaces/my-workspace/hooks?page=0 values: uuid: '{b3329d9d-fcb5-4c19-a5b5-4b0411dc93d1}' url: https://example.com/webhooks/bitbucket description: Webhook for CI/CD pipeline triggers subject_type: repository subject: {} active: true created_at: '2023-11-15T10:30:00Z' events: - repo:push - pullrequest:created - pullrequest:updated - pullrequest:approved - pullrequest:fulfilled secret_set: true paginated-pull-requests_3: size: 50 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests?page=2 previous: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests?page=0 values: links: self: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1 name: 'Pull Request #1' html: href: https://bitbucket.org/myworkspace/myrepo/pull-requests/1 name: View PR commits: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/commits approve: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/approve diff: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/diff diffstat: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/diffstat comments: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/comments activity: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/activity merge: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/merge decline: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests/1/decline id: 1 title: Add new feature implementation rendered: title: raw: Add new feature implementation markup: markdown html:

Add new feature implementation

description: raw: This PR implements the new authentication feature markup: markdown html:

This PR implements the new authentication feature

reason: raw: '' markup: markdown html: '' summary: raw: This PR implements the new authentication feature markup: markdown html:

This PR implements the new authentication feature

state: OPEN merge_commit: hash: a1b2c3d4e5f comment_count: 5 task_count: 2 close_source_branch: true reason: '' created_on: '2024-01-15T10:30:00Z' updated_on: '2024-01-16T14:45:00Z' paginated-deployment-environments: page: 1 values: uuid: 3c7d1b5a-4f2e-4a9c-8d6f-1e2a3b4c5d6e name: production size: 42 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/environments?page=2 previous: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/environments?page=0 paginated-refs: size: 42 page: 1 pagelen: 10 next: https://api.example.com/refs?page=2 previous: https://api.example.com/refs?page=0 values: [] paginated-repository-permissions: size: 42 page: 1 pagelen: 10 next: https://api.example.com/repositories/permissions?page=2 previous: https://api.example.com/repositories/permissions?page=0 values: {} paginated-projects: size: 42 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/workspaces/myworkspace/projects?page=2 previous: https://api.bitbucket.org/2.0/workspaces/myworkspace/projects?page=0 values: links: html: href: https://bitbucket.org/myworkspace/myproject name: Project Home avatar: href: https://bitbucket.org/account/myworkspace/projects/PROJ/avatar/32 name: Avatar uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' key: PROJ owner: {} name: My Project description: This is an example project for organizing repositories is_private: true created_on: '2023-01-15T10:30:00Z' updated_on: '2024-01-10T14:45:00Z' has_publicly_visible_repos: false paginated-pull-requests: size: 42 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests?page=2 previous: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pullrequests?page=0 values: [] paginated-branches: size: 42 page: 1 pagelen: 10 next: https://api.example.com/repositories/my-repo/branches?page=2 previous: https://api.example.com/repositories/my-repo/branches?page=0 values: merge_strategies: - merge_commit - squash - fast_forward default_merge_strategy: merge_commit paginated-project-group-permissions: size: 42 page: 1 pagelen: 10 next: https://api.example.com/project-groups/permissions?page=2 previous: https://api.example.com/project-groups/permissions?page=0 values: [] paginated-workspace-memberships_3: size: 50 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/workspaces/my-workspace/members?page=2 previous: https://api.bitbucket.org/2.0/workspaces/my-workspace/members?page=0 values: links: self: href: https://api.bitbucket.org/2.0/workspaces/my-workspace/members/john-doe name: workspace-membership user: type: user uuid: '{12345678-1234-1234-1234-123456789abc}' username: john-doe display_name: John Doe workspace: type: workspace uuid: '{87654321-4321-4321-4321-cba987654321}' slug: my-workspace name: My Workspace paginated-pipelines: page: 1 values: uuid: '{1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p}' build_number: 42 creator: uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' display_name: John Doe nickname: johndoe account_id: 5d1234567890abcdef123456 repository: uuid: '{b2c3d4e5-f6a7-8901-bcde-f12345678901}' name: my-repo full_name: myworkspace/my-repo target: ref_type: branch ref_name: main commit: hash: a1b2c3d4e5f6 trigger: type: push state: name: COMPLETED type: pipeline_state result: name: SUCCESSFUL variables: - key: ENVIRONMENT value: production secured: false created_on: '2024-01-15T10:30:00.000Z' completed_on: '2024-01-15T10:45:30.000Z' build_seconds_used: 930 size: 150 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/myworkspace/my-repo/pipelines?page=2 previous: null paginated-pipeline-schedule-executions: page: 1 values: example_key: example_value size: 50 pagelen: 10 next: https://api.example.com/pipeline-schedules/executions?page=2 previous: https://api.example.com/pipeline-schedules/executions?page=0 paginated-issues: size: 42 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/example/repo/issues?page=2 previous: https://api.bitbucket.org/2.0/repositories/example/repo/issues?page=0 values: links: self: href: https://api.bitbucket.org/2.0/repositories/example/repo/issues/123 name: 'Issue #123' html: href: https://bitbucket.org/example/repo/issues/123 name: View Issue comments: href: https://api.bitbucket.org/2.0/repositories/example/repo/issues/123/comments name: Comments attachments: href: https://api.bitbucket.org/2.0/repositories/example/repo/issues/123/attachments name: Attachments watch: href: https://api.bitbucket.org/2.0/repositories/example/repo/issues/123/watch name: Watch vote: href: https://api.bitbucket.org/2.0/repositories/example/repo/issues/123/vote name: Vote id: 123 title: Fix login button not responding on mobile devices created_on: '2023-10-15T14:30:00Z' updated_on: '2023-10-16T09:45:00Z' edited_on: '2023-10-16T09:45:00Z' state: open kind: bug priority: major votes: 5 content: raw: The login button does not respond to touch events on iOS devices. markup: markdown html:

The login button does not respond to touch events on iOS devices.

paginated-pipeline-steps: page: 1 values: uuid: 3c7a5e2f-4b8d-4e9a-a1c3-6f2d8b4e9a1c started_on: '2024-01-15T10:30:00Z' completed_on: '2024-01-15T10:35:30Z' state: name: COMPLETED type: pipeline_step_state image: name: atlassian/default-image:latest setup_commands: - name: setup-environment command: export ENV_VAR=value script_commands: - name: build command: npm install - name: test command: npm test size: 50 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/workspace/repo/pipelines/123/steps?page=2 previous: https://api.bitbucket.org/2.0/repositories/workspace/repo/pipelines/123/steps?page=0 paginated-repository-user-permissions: size: 150 page: 1 pagelen: 10 next: https://api.example.com/repositories/permissions?page=2 previous: https://api.example.com/repositories/permissions?page=0 values: {} paginated-pull-request-comments: size: 42 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/example/repo/pullrequests/1/comments?page=2 previous: https://api.bitbucket.org/2.0/repositories/example/repo/pullrequests/1/comments?page=0 values: [] paginated-workspace-memberships: size: 50 page: 1 pagelen: 10 next: https://api.example.com/workspaces/memberships?page=2 previous: https://api.example.com/workspaces/memberships?page=0 values: [] paginated-milestones: size: 42 page: 1 pagelen: 10 next: https://api.example.com/milestones?page=2 previous: https://api.example.com/milestones?page=0 values: links: self: href: https://api.example.com/milestones/123 name: self name: Version 1.0 Release id: 123 paginated-pipeline-known-hosts: page: 1 values: uuid: 123e4567-e89b-12d3-a456-426614174000 hostname: github.com public_key: type: ssh-rsa key: AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ== size: 42 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/workspace/repo/pipelines_config/known_hosts?page=2 previous: https://api.bitbucket.org/2.0/repositories/workspace/repo/pipelines_config/known_hosts?page=0 page: size: 50 page: 1 pagelen: 10 next: https://api.example.com/repositories/commits?page=2 previous: https://api.example.com/repositories/commits?page=0 values: hash: a1b2c3d4e5f6789 date: '2024-01-15T10:30:00Z' author: {} message: Fix bug in authentication module summary: raw: 'Fix bug in authentication module This commit resolves the issue with token validation.' markup: markdown html:

Fix bug in authentication module

This commit resolves the issue with token validation.

parents: [] paginated-pipeline-variables_3: page: 1 values: uuid: 550e8400-e29b-41d4-a716-446655440000 key: DATABASE_URL value: postgres://localhost:5432/mydb secured: false size: 50 pagelen: 10 next: https://api.example.com/pipelines/variables?page=2 previous: https://api.example.com/pipelines/variables?page=0 paginated-repository-permissions_2: size: 42 page: 1 pagelen: 10 next: https://api.example.com/repositories/permissions?page=2 previous: https://api.example.com/repositories/permissions?page=0 values: [] paginated-issue-comments: size: 42 page: 1 pagelen: 10 next: https://api.example.com/issues/comments?page=2 previous: https://api.example.com/issues/comments?page=0 values: issue: {} paginated-reports: page: 1 values: uuid: 123e4567-e89b-12d3-a456-426614174000 title: Security Scan Report details: Automated security vulnerability scan for commit abc123 external_id: security-scan-2024-001 reporter: SecureCode Scanner v2.1 link: https://example.com/reports/security-scan-2024-001 remote_link_enabled: true logo_url: https://example.com/logos/securecodescanner.png report_type: SECURITY result: PASSED data: [] created_on: '2024-01-15T10:30:00Z' updated_on: '2024-01-15T10:35:00Z' size: 42 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/commit/abc123/reports?page=2 previous: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/commit/abc123/reports?page=0 paginated-project-deploy-keys: size: 42 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/projects/PROJ/deploy-keys?page=2 previous: https://api.bitbucket.org/2.0/projects/PROJ/deploy-keys?page=0 values: key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDak... comment: Deploy key for production server label: Production Deploy Key added_on: '2023-11-15T10:30:00Z' last_used: '2024-01-20T14:45:30Z' links: self: href: https://api.bitbucket.org/2.0/projects/PROJ/deploy-keys/123 name: Production Deploy Key paginated-commit-statuses: size: 42 page: 1 pagelen: 10 next: https://api.example.com/commits/statuses?page=2 previous: https://api.example.com/commits/statuses?page=0 values: [] paginated-pipeline-cache: page: 1 values: uuid: 123e4567-e89b-12d3-a456-426614174000 pipeline_uuid: 123e4567-e89b-12d3-a456-426614174001 step_uuid: 123e4567-e89b-12d3-a456-426614174002 name: node_modules_cache key_hash: a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 path: /opt/atlassian/pipelines/agent/build/node_modules file_size_bytes: 52428800 created_on: '2024-01-15T14:30:00Z' size: 42 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/workspace/repo/pipelines-config/caches?page=2 previous: https://api.bitbucket.org/2.0/repositories/workspace/repo/pipelines-config/caches?page=0 paginated-deployments: page: 1 values: uuid: 123e4567-e89b-12d3-a456-426614174000 state: {} environment: {} release: {} size: 42 pagelen: 10 next: https://api.bitbucket.org/2.0/deployments?page=2 previous: https://api.bitbucket.org/2.0/deployments?page=0 paginated-default-reviewer-and-type: size: 42 page: 1 pagelen: 10 next: https://api.example.com/repositories/default-reviewers?page=2 previous: https://api.example.com/repositories/default-reviewers?page=0 values: {} paginated-deployment-variables: page: 1 values: uuid: 123e4567-e89b-12d3-a456-426614174000 key: DATABASE_URL value: postgresql://localhost:5432/mydb secured: false size: 42 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/deployments/variables?page=2 previous: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/deployments/variables?page=0 paginated-snippets: size: 42 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/snippets?page=2 previous: https://api.bitbucket.org/2.0/snippets?page=0 values: id: 12345 title: Example Code Snippet scm: git created_on: '2023-11-15T10:30:00Z' updated_on: '2023-11-16T14:45:30Z' owner: {} creator: {} is_private: true paginated-snippet-comments: size: 42 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/snippets/comments?page=2 previous: https://api.bitbucket.org/2.0/snippets/comments?page=0 values: links: self: href: https://api.bitbucket.org/2.0/snippets/workspace/snippet-id/comments/1 name: Self Link html: href: https://bitbucket.org/workspace/snippet-id#comment-1 name: HTML Link snippet: {} paginated-versions: size: 42 page: 1 pagelen: 10 next: https://api.example.com/versions?page=2 previous: https://api.example.com/versions?page=0 values: links: self: href: https://api.example.com/versions/123 name: self name: Version 1.0 id: 123 paginated-commit-statuses_3: size: 42 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/commit/abc123/statuses?page=2 previous: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/commit/abc123/statuses?page=0 values: links: self: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/commit/abc123/statuses/build/1 name: Build Status commit: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/commit/abc123 name: Commit uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' key: BB-DEPLOY refname: main url: https://builds.example.com/repositories/{repository.full_name}/commits/{commit} state: SUCCESSFUL name: BB-DEPLOY-1 description: Unit tests in Bamboo created_on: '2023-10-15T14:30:00Z' updated_on: '2023-10-15T14:45:00Z' paginated-issue-attachment: size: 42 page: 1 pagelen: 10 next: https://api.example.com/issues/attachments?page=2 previous: https://api.example.com/issues/attachments?page=0 values: links: self: href: https://api.example.com/issues/123/attachments/456 name: attachment-link name: screenshot.png paginated-pipeline-variables: page: 1 values: uuid: 550e8400-e29b-41d4-a716-446655440000 key: DATABASE_URL value: postgresql://localhost:5432/mydb secured: false size: 42 pagelen: 10 next: https://api.example.com/pipelines/variables?page=2 previous: https://api.example.com/pipelines/variables?page=0 paginated-components: size: 42 page: 1 pagelen: 10 next: https://api.example.com/repositories/myrepo/components?page=2 previous: https://api.example.com/repositories/myrepo/components?page=0 values: links: self: href: https://api.example.com/repositories/myrepo/components/123 name: self name: Authentication id: 123 paginated-deploy-keys: size: 42 page: 1 pagelen: 10 next: https://api.example.com/deploy-keys?page=2 previous: https://api.example.com/deploy-keys?page=0 values: key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC... repository: {} comment: Deploy key for production server label: production-server-01 added_on: '2023-10-15T14:30:00Z' last_used: '2024-01-20T09:15:30Z' links: self: href: https://api.example.com/deploy-keys/123 name: production-deploy-key owner: {} page_2: size: 42 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/example/repo/commits?page=2 previous: https://api.bitbucket.org/2.0/repositories/example/repo/commits?page=0 values: hash: a1b2c3d4e5f date: '2024-01-15T10:30:00Z' author: {} message: Initial commit summary: raw: Initial commit with basic structure markup: markdown html:

Initial commit with basic structure

parents: [] paginated-accounts: size: 42 page: 1 pagelen: 10 next: https://api.example.com/accounts?page=2 previous: https://api.example.com/accounts?page=0 values: created_on: '2023-11-15T14:30:00Z' display_name: John Doe username: john_doe-123 uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 paginated-project-user-permissions: size: 42 page: 1 pagelen: 10 next: https://api.example.com/projects/permissions?page=2 previous: https://api.example.com/projects/permissions?page=0 values: [] paginated-accounts_3: size: 42 page: 1 pagelen: 10 next: https://api.example.com/accounts?page=2 previous: https://api.example.com/accounts?page=0 values: created_on: '2023-11-15T10:30:00Z' display_name: John Doe username: john_doe-123 uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 paginated-webhook-subscriptions_2: size: 42 page: 1 pagelen: 10 next: https://api.example.com/webhooks?page=2 previous: https://api.example.com/webhooks?page=0 values: uuid: 550e8400-e29b-41d4-a716-446655440000 url: https://example.com/webhook/endpoint description: Webhook for monitoring pull request events subject_type: repository subject: {} active: true created_at: '2024-01-15T10:30:00Z' events: - pullrequest:created - pullrequest:approved - repo:push secret_set: true secret: my-webhook-secret-key paginated-snippet-commits: size: 42 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/snippets/commits?page=2 previous: https://api.bitbucket.org/2.0/snippets/commits?page=0 values: links: self: href: https://api.bitbucket.org/2.0/snippets/workspace/snippet_id/commits/commit_hash name: Snippet Commit html: href: https://bitbucket.org/workspace/snippet_id/commits/commit_hash name: HTML View diff: href: https://api.bitbucket.org/2.0/snippets/workspace/snippet_id/commits/commit_hash/diff name: Diff snippet: {} paginated-annotations: page: 1 values: external_id: annotation-12345 uuid: 550e8400-e29b-41d4-a716-446655440000 annotation_type: VULNERABILITY path: src/main/java/com/example/Application.java line: 42 summary: Potential SQL injection vulnerability detected details: User input is being concatenated directly into SQL query without sanitization. Consider using parameterized queries to prevent SQL injection attacks. result: FAILED severity: HIGH link: https://security-scanner.example.com/reports/12345 created_on: '2024-01-15T10:30:00Z' updated_on: '2024-01-15T14:45:00Z' size: 50 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/example/repo/commit/abc123/annotations?page=2 previous: https://api.bitbucket.org/2.0/repositories/example/repo/commit/abc123/annotations?page=0 paginated-pipeline-variables_2: page: 1 values: uuid: 3c7a5c08-8b2e-4f9a-9d3e-1a2b3c4d5e6f key: API_KEY value: my-secret-value secured: true size: 42 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pipelines_config/variables?page=2 previous: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pipelines_config/variables?page=0 paginated-files: size: 42 page: 1 pagelen: 10 next: https://api.example.com/repositories/user/repo/commits/abc123/files?page=2 previous: https://api.example.com/repositories/user/repo/commits/abc123/files?page=0 values: [] paginated-tasks: size: 42 page: 1 pagelen: 10 next: https://api.example.com/tasks?page=2 previous: https://api.example.com/tasks?page=0 values: [] paginated-commit-comments_2: size: 42 page: 1 pagelen: 10 next: https://api.example.com/repositories/commits/comments?page=2 previous: https://api.example.com/repositories/commits/comments?page=0 values: commit: {} paginated-pipeline-schedule: page: 1 values: uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 enabled: true target: ref_type: branch ref_name: main cron_pattern: 0 0 12 * * ? * created_on: '2023-10-15T12:00:00Z' updated_on: '2023-10-20T15:30:00Z' size: 42 pagelen: 10 next: https://api.example.com/pipelines/schedules?page=2 previous: https://api.example.com/pipelines/schedules?page=0 paginated-repositories_2: size: 42 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories?page=2 previous: https://api.bitbucket.org/2.0/repositories?page=0 values: links: self: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo name: self html: href: https://bitbucket.org/example-user/example-repo name: html avatar: href: https://bitbucket.org/example-user/example-repo/avatar/32/ name: avatar pullrequests: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/pullrequests name: pullrequests commits: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/commits name: commits forks: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/forks name: forks watchers: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/watchers name: watchers downloads: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/downloads name: downloads clone: - href: https://bitbucket.org/example-user/example-repo.git name: https - href: git@bitbucket.org:example-user/example-repo.git name: ssh hooks: href: https://api.bitbucket.org/2.0/repositories/example-user/example-repo/hooks name: hooks uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' full_name: example-user/example-repo is_private: false scm: git name: example-repo description: This is an example repository created_on: '2023-01-15T10:30:00Z' updated_on: '2024-01-20T14:45:00Z' size: 1024000 language: python has_issues: true has_wiki: true fork_policy: allow_forks paginated-workspace-memberships_2: size: 50 page: 1 pagelen: 10 next: https://api.bitbucket.org/2.0/workspaces/my-workspace/members?page=2 previous: https://api.bitbucket.org/2.0/workspaces/my-workspace/members?page=0 values: links: self: href: https://api.bitbucket.org/2.0/workspaces/my-workspace/members/john-doe name: John Doe Membership user: type: user uuid: '{123e4567-e89b-12d3-a456-426614174000}' username: john-doe display_name: John Doe workspace: type: workspace uuid: '{987fcdeb-51a2-43f7-b890-123456789abc}' slug: my-workspace name: My Workspace paginated-repository-group-permissions: size: 42 page: 1 pagelen: 10 next: https://api.example.com/repositories/groups/permissions?page=2 previous: https://api.example.com/repositories/groups/permissions?page=0 values: [] paginated-pipeline-variables_4: page: 1 values: uuid: 550e8400-e29b-41d4-a716-446655440000 key: DATABASE_URL value: postgresql://localhost:5432/mydb secured: false size: 50 pagelen: 10 next: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pipelines_config/variables?page=2 previous: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/pipelines_config/variables?page=0 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: Use an Atlassian API key as a Bearer token. Create API keys at https://admin.atlassian.com. oauth2: type: oauth2 description: OAuth 2.0 authorization for Atlassian Cloud APIs. flows: authorizationCode: authorizationUrl: https://auth.atlassian.com/authorize tokenUrl: https://auth.atlassian.com/oauth/token scopes: read:org:admin: Read organization information. write:org:admin: Modify organization settings. read:user:admin: Read user information. write:user:admin: Modify user accounts. read:policy:admin: Read organization policies. write:policy:admin: Modify organization policies. read:event:admin: Read organization events. externalDocs: description: Atlassian Admin REST API Documentation url: https://developer.atlassian.com/cloud/admin/organization/rest/intro/