openapi: 3.1.0 info: title: Atlassian Admin Account Get 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: Get paths: /addon/linkers: parameters: [] get: tags: - Get description: 'Gets a list of all [linkers](/cloud/bitbucket/modules/linker/) for the authenticated application.' summary: Atlassian Get Addon Linkers responses: '200': description: Successful. '401': description: Authentication must use app JWT content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: [] - basic: [] - api_key: [] operationId: getAddonLinkers x-microcks-operation: delay: 0 dispatcher: FALLBACK /addon/linkers/{linker_key}: parameters: - name: linker_key in: path description: 'The unique key of a [linker module](/cloud/bitbucket/modules/linker/) as defined in an application descriptor.' required: true schema: type: string get: tags: - Get description: Gets a [linker](/cloud/bitbucket/modules/linker/) specified by `linker_key` for the authenticated application. summary: Atlassian Get Addon Linkers Key responses: '200': description: Successful. '401': description: Authentication must use app JWT content: application/json: schema: $ref: '#/components/schemas/error' '404': description: The linker does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: [] - basic: [] - api_key: [] operationId: getAddonLinkersLinkerKey x-microcks-operation: delay: 0 dispatcher: FALLBACK /addon/linkers/{linker_key}/values: parameters: - name: linker_key in: path description: 'The unique key of a [linker module](/cloud/bitbucket/modules/linker/) as defined in an application descriptor.' required: true schema: type: string get: tags: - Get description: 'Gets a list of all [linker](/cloud/bitbucket/modules/linker/) values for the specified linker of the authenticated application. A linker value lets applications supply values to modify its regular expression. The base regular expression must use a Bitbucket-specific match group `(?K)` which will be translated to `([\w\-]+)`. A value must match this pattern. [Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)' summary: Atlassian Get Addon Linkers Key Values responses: '200': description: Successful. '401': description: Authentication must use app JWT content: application/json: schema: $ref: '#/components/schemas/error' '404': description: The linker does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: [] - basic: [] - api_key: [] operationId: getAddonLinkersLinkerKeyValues x-microcks-operation: delay: 0 dispatcher: FALLBACK /addon/linkers/{linker_key}/values/{value_id}: parameters: - name: linker_key in: path description: 'The unique key of a [linker module](/cloud/bitbucket/modules/linker/) as defined in an application descriptor.' required: true schema: type: string - name: value_id in: path description: The numeric ID of the linker value. required: true schema: type: integer get: tags: - Get description: 'Get a single [linker](/cloud/bitbucket/modules/linker/) value of the authenticated application.' summary: Atlassian Get Addon Linkers Key Values Value Id responses: '200': description: Successful. '401': description: Authentication must use app JWT content: application/json: schema: $ref: '#/components/schemas/error' '404': description: The linker value does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: [] - basic: [] - api_key: [] operationId: getAddonLinkersLinkerKeyValuesValueId x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}: 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: - Get description: 'The Get Pull Request operation retrieves detailed information about a specific pull request within a Bitbucket repository by making a GET request to the endpoint /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}. This API call requires three path parameters: the workspace identifier, the repository slug, and the unique pull request ID. When invoked, it returns comprehensive data about the specified pull request, including its title, description, source and destination branches, author information, creation and update timestamps, current state (open, merged, declined), reviewer details, approval status, merge commit information if applicable, and associated metadata such as task counts and comment statistics. This operation is commonly used by developers and tools to inspect pull request details, monitor review progress, and integrate pull request workflows into CI/CD pipelines or project management systems.' summary: Atlassian Get Pull Request responses: '200': description: The pull request object content: application/json: schema: $ref: '#/components/schemas/pullrequest' '401': description: If the repository is private and the request was not authenticated. '404': description: If the repository or 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: getPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}: parameters: - name: comment_id in: path description: The id of the comment. required: true schema: type: integer - 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: - Get description: This API endpoint retrieves a specific comment from a pull request in a Bitbucket repository. By providing the workspace identifier, repository slug, pull request ID, and comment ID in the URL path, you can fetch detailed information about an individual comment, including its content, author, creation timestamp, and any associated metadata. This is useful when you need to access or display a particular comment without retrieving all comments on the pull request, making it more efficient for targeted comment operations such as displaying comment details, implementing deep linking to specific comments, or performing comment-specific actions in your application. summary: Atlassian Get Comment on Pull Request responses: '200': description: The comment. content: application/json: schema: $ref: '#/components/schemas/pullrequest_comment' examples: undefined: $ref: '#/components/examples/undefined' '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 comment 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: getCommentOnPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat: 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: - Get description: 'This API endpoint retrieves the diffstat for a specific pull request in a Bitbucket repository, providing statistical information about the changes introduced by the pull request. It requires three path parameters: the workspace identifier, the repository slug, and the pull request ID. When called, it returns a summary of file modifications including the number of lines added, removed, and modified for each file affected by the pull request, which helps developers quickly understand the scope and impact of the proposed changes without reviewing the full diff.' summary: Atlassian Get the Diff Stat for Pull Request responses: '302': description: 'Redirects to the [repository diffstat](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-diffstat-spec-get) with the revspec that corresponds to pull request. ' security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: getTheDiffStatForPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge/task-status/{task_id}: 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: task_id in: path description: ID of the merge task 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: - Get description: This GET endpoint retrieves the current status of a merge task for a specific pull request in a Bitbucket repository. By providing the workspace identifier, repository slug, pull request ID, and task ID in the URL path, users can poll this endpoint to monitor the progress of an asynchronous merge operation. The response typically includes information about whether the merge task is pending, in progress, completed successfully, or has failed, along with any relevant error messages or completion details. This is particularly useful for tracking long-running merge operations or implementing automated workflows that need to wait for merge completion before proceeding with subsequent actions. summary: Atlassian Get the Merge Task Status for Pull Request responses: '200': description: Returns a task status if the merge is either pending or successful, and if it is successful, a pull request '400': description: If the provided task ID does not relate to this pull request, or if something went wrong during the merge operation '403': description: The user making the request does not have permission to the repo and is different from the user who queued the task security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: getTheMergeTaskStatusForPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patch: 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: - Get description: 'The Atlassian Bitbucket Pull Requests API endpoint `/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patch` using the GET method retrieves the raw patch file representation of a specific pull request, which contains the unified diff format showing all code changes between the source and destination branches. This endpoint requires three path parameters: the workspace identifier, the repository slug, and the pull request ID, and returns the patch in text format that can be applied using standard patch utilities or version control commands. The patch output includes metadata such as commit information, file modifications, additions, and deletions, making it useful for code review processes, automated testing pipelines, or applying changes across different repositories without performing a full merge operation.' summary: Atlassian Get the Patch for Pull Request responses: '302': description: 'Redirects to the [repository patch](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-patch-spec-get) with the revspec that corresponds to pull request. ' security: - oauth2: - pullrequest - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:pullrequest:bitbucket operationId: getThePatchForPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks/{task_id}: 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: task_id in: path description: The ID of the task. required: true schema: type: integer - 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: - Get description: The Get Task On Pull Request operation retrieves detailed information about a specific task associated with a pull request in a Bitbucket repository. By providing the workspace identifier, repository slug, pull request ID, and task ID in the endpoint path, this GET request returns the task's complete details including its content, status, creation date, assignee information, and any related metadata. This endpoint is useful for tracking individual tasks within a pull request's review process, allowing developers and team members to monitor task completion, view task descriptions, and understand task-specific requirements without having to fetch all tasks associated with the pull request. summary: Atlassian Get Task on Pull Request responses: '200': description: The task. content: application/json: schema: $ref: '#/components/schemas/A_pullrequest_comment_task' examples: undefined: $ref: '#/components/examples/undefined' '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 task 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: getTaskOnPullRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}: get: responses: '200': description: The value of the property. content: application/json: schema: $ref: '#/components/schemas/application_property' examples: application-property: $ref: '#/components/examples/application-property' operationId: getPullRequestApplicationProperty summary: Atlassian Get Pull Request Application Property description: This API endpoint retrieves a specific application property value associated with a pull request in a Bitbucket repository, identified by the workspace, repository slug, pull request ID, application key, and property name parameters in the URL path. Application properties allow third-party apps and integrations to store custom metadata or configuration data against individual pull requests, enabling extended functionality beyond Bitbucket's native features. The GET operation returns the stored property value for the specified property name under the given app key, allowing applications to retrieve their previously stored data for use in workflows, automation, or custom UI elements related to the pull request. parameters: - required: true in: path name: workspace description: The repository container; either the workspace slug or the UUID in curly braces. schema: type: string - required: true in: path name: repo_slug description: The repository. schema: type: string - required: true in: path name: pullrequest_id description: The pull request ID. schema: type: string - required: true in: path name: app_key description: The key of the Connect app. schema: type: string - required: true in: path name: property_name description: The name of the property. schema: type: string tags: - Get security: - oauth2: [] - basic: [] - api_key: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{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: - Get description: This API operation retrieves detailed information about a specific Bitbucket repository within a workspace by providing the workspace identifier and repository slug as path parameters. When you make a GET request to this endpoint, it returns comprehensive metadata about the repository including its name, description, visibility settings (public or private), creation date, size, language, fork information, owner details, and various URLs for accessing the repository through different protocols. This is useful for applications that need to display repository information, verify repository existence, check permissions, or gather data about a repository before performing other operations on it. summary: Atlassian Get Repository responses: '200': description: The repository object. content: application/json: schema: $ref: '#/components/schemas/repository' examples: repository: $ref: '#/components/examples/repository' '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: If no repository exists at this location. 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: getRepository x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}: parameters: - name: id in: path description: The restriction rule's 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: - Get description: The GET operation on the /repositories/{workspace}/{repo_slug}/branch-restrictions/{id} endpoint in the Atlassian Bitbucket Repositories API retrieves detailed information about a specific branch restriction rule within a repository. By providing the workspace identifier, repository slug, and the unique ID of the branch restriction, this operation returns the complete configuration of that particular rule, including its type (such as requiring pull request approvals, restricting pushes, or enforcing merge checks), the branch pattern it applies to, the users or groups it affects, and any associated permissions or conditions. This endpoint is useful for administrators and developers who need to audit existing branch protection settings, verify security policies, or programmatically inspect repository governance rules before making modifications. summary: Atlassian Get Branch Restriction Rule responses: '200': description: The branch restriction rule content: application/json: schema: $ref: '#/components/schemas/branchrestriction' examples: branch-restriction_2: $ref: '#/components/examples/branch-restriction_2' '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 or branch restriction id does not exist content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository:admin - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - admin:repository:bitbucket operationId: getBranchRestrictionRule x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/branching-model: 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: - Get description: This API operation retrieves the branching model configuration for a specific Bitbucket repository within a given workspace. By making a GET request to the endpoint with the appropriate workspace identifier and repository slug, it returns details about the repository's branching strategy, including information about production, development, and feature branch configurations, as well as any custom branch prefixes and patterns that have been defined. This is particularly useful for understanding how a team has structured their Git workflow, whether they're using Git Flow, trunk-based development, or a custom branching strategy, and helps developers and automation tools align with the repository's established branching conventions. summary: Atlassian Get the Branching Model for Repository responses: '200': description: The branching model object content: application/json: schema: $ref: '#/components/schemas/branching_model' examples: branching-model_2: $ref: '#/components/examples/branching-model_2' '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 read 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' security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: getTheBranchingModelForRepository x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/branching-model/settings: 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: - Get description: This API operation retrieves the branching model configuration settings for a specific repository within an Atlassian Bitbucket workspace. By making a GET request to the endpoint with the workspace identifier and repository slug as path parameters, users can access the repository's configured branching strategy, which may include settings for development branches, production branches, branch prefixes, and other workflow-related configurations that govern how branches are created and managed within that repository. This information is useful for understanding the repository's branching conventions and automating branch creation processes according to the established model. summary: Atlassian Get the Branching Model Config for Repository responses: '200': description: The branching model configuration content: application/json: schema: $ref: '#/components/schemas/branching_model_settings' examples: branching-model-settings_2: $ref: '#/components/examples/branching-model-settings_2' '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' security: - oauth2: - repository:admin - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - admin:repository:bitbucket operationId: getTheBranchingModelConfigForRepository x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}: 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: - Get description: This API operation retrieves detailed information about a specific commit in a Bitbucket repository by making a GET request to the endpoint with the workspace identifier, repository slug, and commit hash as path parameters. It returns comprehensive commit data including the commit message, author information, timestamp, changed files, diff statistics, parent commits, and any associated metadata. This endpoint is useful for examining the details of individual commits, auditing code changes, building commit history visualizations, or integrating commit information into external tools and workflows. summary: Atlassian Get Commit responses: '200': description: The commit object content: application/json: schema: $ref: '#/components/schemas/commit' examples: commit_2: $ref: '#/components/examples/commit_2' '404': description: If the specified commit or 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: getCommit x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id}: parameters: - name: comment_id in: path description: The id of the comment. required: true schema: type: integer - 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: - Get description: This API endpoint retrieves a specific comment on a commit within a Bitbucket repository. By providing the workspace identifier, repository slug, commit hash, and comment ID in the request path, users can fetch detailed information about a particular comment that was made on a commit, including the comment content, author information, timestamps, and any associated metadata. This is useful for applications that need to display, process, or analyze individual commit comments, such as code review tools, notification systems, or audit logs that track discussion and feedback on specific code changes. summary: Atlassian Get Commit Comment responses: '200': description: The commit comment. content: application/json: schema: $ref: '#/components/schemas/commit_comment' examples: commit-comment_2: $ref: '#/components/examples/commit-comment_2' security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: getCommitComment x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}: get: responses: '200': description: The value of the property. content: application/json: schema: $ref: '#/components/schemas/application_property' examples: application-property: $ref: '#/components/examples/application-property_3' operationId: getCommitApplicationProperty summary: Atlassian Get Commit Application Property description: This GET operation retrieves a specific application property associated with a commit in a Bitbucket repository. By providing the workspace identifier, repository slug, commit hash, application key, and property name in the URL path, the API returns the value of the custom property that was previously set on that commit by a specific application. This allows applications to store and retrieve metadata or custom attributes tied to individual commits, enabling features like tracking deployment status, code review approvals, or other application-specific information linked to particular commits in the repository's history. parameters: - required: true in: path name: workspace description: The repository container; either the workspace slug or the UUID in curly braces. schema: type: string - required: true in: path name: repo_slug description: The repository. schema: type: string - required: true in: path name: commit description: The commit. schema: type: string - required: true in: path name: app_key description: The key of the Connect app. schema: type: string - required: true in: path name: property_name description: The name of the property. schema: type: string tags: - Get security: - oauth2: [] - 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}: get: tags: - Get description: The Get Report operation in the Atlassian Bitbucket Repositories API retrieves details of a specific report associated with a commit in a repository. By providing the workspace identifier, repository slug, commit hash, and report ID as path parameters, this endpoint returns comprehensive information about a particular report that has been created for the specified commit. Reports are typically used to provide feedback on code quality, test results, security scans, or other automated checks that run as part of a CI/CD pipeline. The response includes the report's status, title, description, reporter details, result summary, and any additional metadata associated with the report, allowing developers and automated systems to programmatically access and review commit-level analysis results within their Bitbucket workflows. summary: Atlassian Get Report operationId: getReport 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 the report belongs to. required: true in: path schema: type: string - name: reportId description: Either the uuid or external-id of the report. required: true in: path schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/report' examples: commit-report_2: $ref: '#/components/examples/commit-report_2' '404': description: The report with the given ID was not found. content: application/json: schema: $ref: '#/components/schemas/error' 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/{annotationId}: get: tags: - Get description: This API operation retrieves a specific annotation associated with a code insights report for a particular commit in a Bitbucket repository. By providing the workspace identifier, repository slug, commit hash, report ID, and annotation ID in the URL path, users can fetch detailed information about a single annotation that was previously created for code quality, security findings, or other automated analysis results. The annotation typically contains metadata such as the file path, line number, severity level, and description of an issue or finding detected in the code at that specific commit point. summary: Atlassian Get an Annotation operationId: getAnAnnotation 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 the report belongs to. required: true in: path schema: type: string - name: reportId description: Either the uuid or external-id of the report. required: true in: path schema: type: string - name: annotationId description: Either the uuid or external-id of the annotation. required: true in: path schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/report_annotation' examples: report-annotation: $ref: '#/components/examples/report-annotation' '404': description: The annotation with the given ID was not found. content: application/json: schema: $ref: '#/components/schemas/error' 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/build/{key}: parameters: - name: commit in: path description: The Commits SHA1. required: true schema: type: string - name: key in: path description: The build status' unique key 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: - Get description: Retrieves a specific build status object associated with a commit in a Bitbucket repository, identified by a unique key. This endpoint allows you to query the detailed status information of a particular build or CI/CD pipeline execution that was reported for a given commit. You must provide the workspace identifier, repository slug, commit hash, and the unique key of the build status you want to retrieve. The response includes comprehensive details about the build execution such as its state (successful, failed, in progress), description, URL to view the build results, and timestamp information. This is particularly useful for integrating with external CI/CD systems, monitoring build pipelines, or displaying build status information in custom dashboards and applications. summary: Atlassian Get Build Status for Commit responses: '200': description: The build status object with the specified key. content: application/json: schema: $ref: '#/components/schemas/commitstatus' examples: commit-status_2: $ref: '#/components/examples/commit-status_2' '401': description: If the repository is private and the request was not authenticated. '404': description: If the repository, commit, or build status key 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: getBuildStatusForCommit x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/components/{component_id}: parameters: - name: component_id in: path description: The component's id 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: - Get description: This API operation retrieves detailed information about a specific component within a Bitbucket repository's issue tracking system. By providing the workspace identifier, repository slug, and component ID in the endpoint path, users can fetch metadata and configuration details for that particular component, which is typically used to categorize and organize issues within the repository. Components help teams structure their issue tracking by grouping related issues together, such as by feature area, module, or subsystem, and this GET request returns the properties and settings associated with the specified component. summary: Atlassian Get Component for Issues responses: '200': description: The specified component object. content: application/json: schema: $ref: '#/components/schemas/component' examples: component: $ref: '#/components/examples/component' '404': description: The specified repository or component 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: getComponentForIssues x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}: 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: target_username in: path description: 'This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: `{account 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: - Get description: Retrieves information about a specific default reviewer for a Bitbucket repository within a workspace. This GET endpoint allows you to fetch details of a user who has been designated as a default reviewer for pull requests in the specified repository by providing the workspace identifier, repository slug, and the target username of the reviewer. The operation returns the default reviewer's configuration and user details, enabling you to verify reviewer assignments and understand the current code review workflow settings for the repository. summary: Atlassian Get Default Reviewer responses: '200': description: The specified user is a default reviewer content: application/json: schema: $ref: '#/components/schemas/account' examples: account: $ref: '#/components/examples/account' '403': description: If the authenticated user does not have access to check if the specified user is a default reviewer content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the specified user does not exist or is not a default reviewer 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: getDefaultReviewer x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}: parameters: - name: key_id in: path description: The key ID matching the deploy key. 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: - Get description: This API operation retrieves detailed information about a specific deploy key that has been added to a Bitbucket repository. By providing the workspace identifier, repository slug, and the unique key ID, you can fetch the complete configuration and metadata associated with that particular SSH deploy key, including its label, the actual public key content, creation timestamp, and access permissions. Deploy keys are typically used to grant read-only or read-write access to repositories for automated deployment systems and CI/CD pipelines without requiring a user account, and this endpoint allows administrators to verify and audit the deploy keys currently configured for their repository. summary: Atlassian Get Repository Deploy Key responses: '200': description: Deploy key matching the key ID content: application/json: schema: $ref: '#/components/schemas/deploy_key' examples: deploy-key_2: $ref: '#/components/examples/deploy-key_2' '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: getRepositoryDeployKey x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid}: get: tags: - Get description: This GET operation retrieves detailed information about a specific deployment in a Bitbucket repository by providing the workspace identifier, repository slug, and unique deployment UUID in the endpoint path. It allows users to fetch comprehensive deployment data including deployment status, environment details, timestamps, and associated metadata for a particular deployment instance within the specified repository, enabling monitoring and tracking of deployment activities across different environments in the Bitbucket deployment pipeline. summary: Atlassian Get Deployment operationId: getDeployment 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: deployment_uuid description: The deployment UUID. required: true in: path schema: type: string responses: '200': description: The deployment. content: application/json: schema: $ref: '#/components/schemas/deployment' examples: deployment: $ref: '#/components/examples/deployment' '404': description: No account, repository or deployment with the UUID provided exists. content: application/json: schema: $ref: '#/components/schemas/error' 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/{filename}: parameters: - name: filename in: path description: Name of 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: - Get description: 'The Atlassian Bitbucket Repositories API endpoint `/repositories/{workspace}/{repo_slug}/downloads/{filename}` using the GET method retrieves a redirect link to download a specific file artifact that has been uploaded to a repository''s downloads section. This operation requires three path parameters: the workspace ID or slug that owns the repository, the repository slug identifier, and the exact filename of the download artifact you want to access. When called, instead of returning the file content directly, the API responds with a 302 redirect to the actual download URL where the file is stored, allowing clients to fetch the artifact from Bitbucket''s storage infrastructure. This is particularly useful for accessing release binaries, documentation archives, or other supplementary files associated with a repository that aren''t part of the source code itself.' summary: Atlassian Get Download Artifact Link responses: '302': description: Redirects to the url of the specified download artifact. '403': description: User is not authorized to read from the repository. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: The specified download artifact does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - repository - basic: [] - api_key: [] operationId: getDownloadArtifactLink x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/effective-branching-model: 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: - Get description: This API operation retrieves the effective branching model currently applied to a specific Bitbucket repository within a given workspace. By providing the workspace identifier and repository slug as path parameters, it returns the active branching model configuration that governs how branches are organized and managed in that repository, including details about production branches, development branches, and any branch prefixes or patterns that are in use. This is particularly useful for understanding the workflow strategy implemented for the repository, whether it follows Git Flow, trunk-based development, or a custom branching strategy, and helps developers align their work with the established branch management conventions. summary: Atlassian Get the Effective, or Currently Applied, Branching Model for Repository responses: '200': description: The effective branching model object content: application/json: schema: $ref: '#/components/schemas/effective_repo_branching_model' examples: effective-repository-branching-model: $ref: '#/components/examples/effective-repository-branching-model' '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 read 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' security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repositoryBitbucket operationId: getTheEffective,OrCurrentlyApplied,BranchingModelForRepository x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}: get: tags: - Get summary: Atlassian Get an Environment description: Retrieves detailed information about a specific deployment environment within a Bitbucket repository. This endpoint requires the workspace identifier, repository slug, and the unique UUID of the environment you want to retrieve. The operation returns comprehensive details about the environment including its name, type, environment variables, deployment restrictions, and any associated configuration. This is useful for auditing environment settings, verifying deployment configurations, or integrating environment data into external tools and workflows. Access to this endpoint typically requires appropriate repository permissions and authentication credentials. operationId: getAnEnvironment 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 UUID. required: true in: path schema: type: string responses: '200': description: The environment. content: application/json: schema: $ref: '#/components/schemas/deployment_environment' examples: deployment-environment_2: $ref: '#/components/examples/deployment-environment_2' '404': description: No account, repository or environment with the UUID provided exists. content: application/json: schema: $ref: '#/components/schemas/error' 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}/hooks/{uid}: 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: uid in: path description: Installed webhook's 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: - Get description: This API operation retrieves details about a specific webhook configured for a Bitbucket repository. By providing the workspace identifier, repository slug, and unique webhook ID (uid) in the endpoint path, users can fetch comprehensive information about that particular webhook including its URL, events it subscribes to, configuration settings, and current status. This GET request is useful for inspecting existing webhook configurations, verifying webhook properties, or retrieving webhook details before performing update or delete operations. The response returns a complete webhook object containing all its attributes and settings as configured for the specified repository. summary: Atlassian Get Webhook for Repository responses: '200': description: The webhook subscription object. content: application/json: schema: $ref: '#/components/schemas/webhook_subscription' examples: webhook-subscription_2: $ref: '#/components/examples/webhook-subscription_2' '404': description: If the webhook or repository does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - webhook - basic: [] - api_key: [] operationId: getWebhookForRepository x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/issues/{issue_id}: 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: - Get description: This GET operation retrieves detailed information about a specific issue from a Bitbucket repository by providing the workspace identifier, repository slug, and issue ID as path parameters. It returns comprehensive data about the requested issue including its title, description, status, priority, assignee, reporter, creation and update timestamps, comments, and other metadata associated with the issue. This endpoint is useful for developers and project managers who need to fetch complete details of a particular issue for display in dashboards, integration with third-party tools, or programmatic issue tracking and management within the Atlassian Bitbucket ecosystem. summary: Atlassian Get an Issue responses: '200': description: The issue object. content: application/json: schema: $ref: '#/components/schemas/issue' examples: issue_2: $ref: '#/components/examples/issue_2' '403': description: When the authenticated user isn't authorized to access the issue. content: application/json: schema: $ref: '#/components/schemas/error' '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' '410': description: The specified issue is unavailable. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - issue - basic: [] - api_key: [] operationId: getAnIssue 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/{path}: parameters: - name: issue_id in: path description: The issue id 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: - Get description: This API operation retrieves a specific attachment file associated with an issue in a Bitbucket repository by providing the workspace identifier, repository slug, issue ID, and the path to the attachment file. When called, it returns the binary content of the requested attachment, allowing users to download or access files that have been previously uploaded to an issue, such as screenshots, logs, or other supporting documentation that help describe or troubleshoot the reported issue. summary: Atlassian Get Attachment for an Issue responses: '302': description: A redirect to the file's contents headers: Location: schema: type: string '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: getAttachmentForAnIssue x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes/{change_id}: parameters: - name: change_id in: path description: The issue change id required: true schema: type: string - 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: - Get description: This GET endpoint retrieves a specific change object associated with an issue in a Bitbucket repository, allowing users to examine the detailed history of modifications made to a particular issue. By providing the workspace identifier, repository slug, issue ID, and change ID in the URL path, the API returns comprehensive information about a single change event, including what was modified, when the change occurred, and who made the modification. This is particularly useful for tracking issue evolution, auditing purposes, or understanding the context of specific updates made to issues within the repository's issue tracking system. summary: Atlassian Get Issue Change Object responses: '200': description: The specified issue change object. content: application/json: schema: $ref: '#/components/schemas/issue_change' examples: issue-change_2: $ref: '#/components/examples/issue-change_2' '404': description: The specified repository or issue change 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: getIssueChangeObject 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/{comment_id}: parameters: - name: comment_id in: path description: The id of the comment. required: true schema: type: integer - 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: - Get description: This API operation retrieves a specific comment from an issue within a Bitbucket repository by providing the workspace identifier, repository slug, issue ID, and comment ID in the endpoint path. It returns detailed information about the comment including its content, author, creation date, modification history, and any associated metadata. This GET request is useful for accessing individual comment details without fetching all comments on an issue, enabling efficient retrieval of specific discussion threads or responses within the repository's issue tracking system. summary: Atlassian Get Comment on an Issue responses: '200': description: The issue comment. content: application/json: schema: $ref: '#/components/schemas/issue_comment' examples: issue-comment_2: $ref: '#/components/examples/issue-comment_2' security: - oauth2: - issue - basic: [] - api_key: [] operationId: getCommentOnAnIssue x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/merge-base/{revspec}: 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: revspec in: path description: 'A commit range using double dot notation (e.g. `3a8b42..9ff173`). ' 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: - Get description: This API endpoint retrieves the common ancestor commit between two specified commits in a Bitbucket repository. By providing the workspace identifier, repository slug, and a revspec parameter that identifies two commits (typically in the format "commit1...commit2"), the operation returns information about the most recent commit that exists in both commits' histories. This is particularly useful for understanding the branching point between two lines of development, determining what changes have diverged between branches, or preparing for merge operations by identifying the base commit from which both branches originated. summary: Atlassian Get the Common Ancestor Between Two Commits responses: '200': description: The merge base of the provided spec. content: application/json: schema: $ref: '#/components/schemas/commit' examples: commit_2: $ref: '#/components/examples/commit_2' '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 access to any of the repositories specified. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the repository or ref in the spec 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: getTheCommonAncestorBetweenTwoCommits x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/milestones/{milestone_id}: parameters: - name: milestone_id in: path description: The milestone's id 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: - Get description: This GET operation retrieves detailed information about a specific milestone within a Bitbucket repository by providing the workspace identifier, repository slug, and milestone ID as path parameters. The endpoint returns comprehensive data about the milestone including its name, description, state (open or closed), due date, and associated metadata such as creation and update timestamps. This allows developers to programmatically access milestone information for project tracking, reporting, or integration with external project management tools, enabling them to monitor progress and deadlines for features or releases defined within their Bitbucket repositories. summary: Atlassian Get Milestone responses: '200': description: The specified milestone object. content: application/json: schema: $ref: '#/components/schemas/milestone' examples: milestone: $ref: '#/components/examples/milestone' '404': description: The specified repository or milestone 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: getMilestone x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/patch/{spec}: 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: spec in: path description: 'A commit SHA (e.g. `3a8b42`) or a commit range using double dot notation (e.g. `3a8b42..9ff173`). ' 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: - Get description: This API endpoint retrieves a raw unified diff patch comparing two commits within a specific Bitbucket repository. By providing the workspace identifier, repository slug, and a commit specification (typically in the format "commit1..commit2"), the endpoint returns the patch content showing the line-by-line differences between the two commits. This is particularly useful for code review processes, examining specific changes between versions, or programmatically analyzing modifications made to a codebase. The patch follows the standard unified diff format, making it compatible with various version control tools and patch application utilities. summary: Atlassian Get Patch for Two Commits responses: '200': description: The raw patches '555': description: 'If the diff was too large and timed out. Since this endpoint does not employ any form of pagination, but instead returns the diff as a single document, it can run into trouble on very large diffs. If Bitbucket times out in cases like these, a 555 status code is returned.' 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: getPatchForTwoCommits x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}: parameters: - name: group_slug in: path description: Slug of the requested group. 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: - Get description: This API operation retrieves explicit permission settings assigned to a specific group for a given repository in Bitbucket. By providing the workspace identifier, repository slug, and group slug as path parameters, it returns detailed information about the permission level that has been directly granted to that group for accessing and managing the specified repository. This is useful for administrators who need to audit or verify group-level access controls, as it shows only explicitly configured permissions rather than inherited or default permissions. The response typically includes the group's identifier, the permission level (such as read, write, or admin), and potentially additional metadata about when and how the permission was assigned. summary: Atlassian Get an Explicit Group Permission for Repository responses: '200': description: Group permission for group slug and repository content: application/json: schema: $ref: '#/components/schemas/repository_group_permission' examples: repository-group-permission: $ref: '#/components/examples/repository-group-permission' '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: The given user, workspace, and/or repository could not be found 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: getAnExplicitGroupPermissionForRepository x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id}: 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: selected_user_id in: path description: 'This can either be the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`, OR an Atlassian Account 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: - Get description: This API endpoint retrieves the explicit permission settings for a specific user on a particular Bitbucket repository within a workspace. By providing the workspace identifier, repository slug, and the selected user's ID in the path parameters, it returns detailed information about what level of access (such as read, write, or admin) has been directly granted to that user for the specified repository. This is useful for auditing user permissions, managing repository access control, and understanding who has been explicitly granted permissions rather than inheriting them through group memberships or workspace-level settings. summary: Atlassian Get an Explicit User Permission for Repository responses: '200': description: Explicit user permission for user and repository content: application/json: schema: $ref: '#/components/schemas/repository_user_permission' examples: repository-user-permission: $ref: '#/components/examples/repository-user-permission' '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: getAnExplicitUserPermissionForRepository x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri: get: tags: - Get summary: Atlassian Get Cache Content Uri description: This API operation retrieves a temporary content URI for accessing a specific pipeline cache in a Bitbucket repository. By providing the workspace ID, repository slug, and cache UUID as path parameters, you can obtain a pre-signed URL that allows direct access to download the cached content. This is useful for retrieving build artifacts, dependencies, or other cached data that was stored during previous pipeline executions, enabling faster build times by reusing previously downloaded or generated files. The returned URI is typically time-limited and provides secure, temporary access to the cache content without requiring additional authentication once generated. operationId: getCacheContentUri 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 - name: cache_uuid description: The UUID of the cache. required: true in: path schema: type: string responses: '200': description: The cache content uri. content: application/json: schema: $ref: '#/components/schemas/pipeline_cache_content_uri' examples: pipeline-cache-content-uri: $ref: '#/components/examples/pipeline-cache-content-uri' '404': description: The workspace, repository or cache_uuid with given UUID 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}: get: tags: - Get summary: Atlassian Get Pipeline description: Retrieves detailed information about a specific pipeline execution in a Bitbucket repository. This endpoint requires the workspace slug, repository slug, and the unique pipeline UUID to fetch comprehensive data about a particular pipeline run, including its current status, configuration, build number, duration, creator information, and associated commit details. The response provides insights into the pipeline's execution history and can be used to monitor CI/CD processes, track build progress, or integrate pipeline status into external tools and dashboards. operationId: getPipeline 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 pipeline UUID. required: true in: path schema: type: string responses: '200': description: The pipeline. content: application/json: schema: $ref: '#/components/schemas/pipeline' examples: pipeline_2: $ref: '#/components/examples/pipeline_2' '404': description: No account, repository or pipeline with the UUID provided exists. 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/{step_uuid}: get: tags: - Get summary: Atlassian Get Step of Pipeline description: This API operation retrieves detailed information about a specific step within a pipeline execution in a Bitbucket repository. By providing the workspace identifier, repository slug, pipeline UUID, and step UUID as path parameters, you can fetch comprehensive data about an individual step's status, configuration, duration, logs reference, and execution details within the context of a Bitbucket Pipelines build process. This endpoint is useful for monitoring pipeline progress, debugging failed builds, or integrating pipeline step information into external tools and dashboards. operationId: getStepOfPipeline 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 - name: step_uuid description: The UUID of the step. required: true in: path schema: type: string responses: '200': description: The step. content: application/json: schema: $ref: '#/components/schemas/pipeline_step' examples: pipeline-step: $ref: '#/components/examples/pipeline-step' '404': description: No account, repository, pipeline or step with the UUID provided exists for the pipeline with the UUID provided. 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/{step_uuid}/log: get: tags: - Get summary: Atlassian Get Log File for Step description: This API operation retrieves the log file for a specific step within a Bitbucket pipeline. By providing the workspace ID, repository slug, pipeline UUID, and step UUID, you can access the detailed execution logs generated during that particular pipeline step. The logs contain console output, error messages, and other diagnostic information that occurred while the step was running, which is useful for debugging failed builds, monitoring deployment processes, or auditing pipeline execution history. This endpoint returns the raw log content that was captured during the step's execution in the CI/CD pipeline. operationId: getLogFileForStep 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 - name: step_uuid description: The UUID of the step. required: true in: path schema: type: string responses: '200': description: The raw log file for this pipeline step. '304': description: The log has the same etag as the provided If-None-Match header. content: application/octet-stream: schema: $ref: '#/components/schemas/error' '404': description: A pipeline with the given UUID does not exist, a step with the given UUID does not exist in the pipeline or a log file does not exist for the given step. content: application/octet-stream: schema: $ref: '#/components/schemas/error' '416': description: The requested range does not exist for requests that specified the [HTTP Range header](https://tools.ietf.org/html/rfc7233#section-3.1). content: application/octet-stream: 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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid}: get: tags: - Get summary: Atlassian Get the Logs for the Build Container or Service Container for Given Step of Pipeline. description: This API endpoint retrieves the logs for a specific build or service container associated with a particular step in a Bitbucket pipeline execution. By providing the workspace identifier, repository slug, pipeline UUID, step UUID, and log UUID, developers can access detailed log information that captures the output and execution details of containers running during the pipeline process. This is particularly useful for debugging pipeline failures, monitoring build processes, and tracking the behavior of services or builds within a specific pipeline step, enabling teams to troubleshoot issues and optimize their CI/CD workflows effectively. operationId: getTheLogsForTheBuildContainerOrServiceContainerForGivenStepOfPipeline 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 - name: step_uuid description: The UUID of the step. required: true in: path schema: type: string - name: log_uuid description: For the main build container specify the step UUID; for a service container specify the service container UUID required: true in: path schema: type: string responses: '200': description: The raw log file for the build container or service container. '404': description: No account, repository, pipeline, step or log exist for the provided path. content: application/octet-stream: 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: ChooseTags: true WriteDescription: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports: get: tags: - Get summary: Atlassian Get Summary of Test Reports for Given Step of Pipeline. operationId: getSummaryOfTestReportsForGivenStepOfPipeline 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 - name: step_uuid description: The UUID of the step. required: true in: path schema: type: string responses: '200': description: A summary of test reports for this pipeline step. '404': description: No account, repository, pipeline, step or test reports exist for the provided path. 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: [] description: This API endpoint retrieves a comprehensive summary of test reports for a specific step within a pipeline execution in a Bitbucket repository. By providing the workspace identifier, repository slug, pipeline UUID, and step UUID as path parameters, users can access aggregated test results including passed, failed, and skipped tests, along with detailed metrics and statistics generated during that particular pipeline step's test execution phase. x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases: get: tags: - Get summary: Atlassian Get Test Cases for Given Step of Pipeline. operationId: getTestCasesForGivenStepOfPipeline 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 - name: step_uuid description: The UUID of the step. required: true in: path schema: type: string responses: '200': description: Test cases for this pipeline step. '404': description: No account, repository, pipeline, step or test reports exist for the provided path. 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: [] description: This API operation retrieves test case results for a specific step within a pipeline execution in a Bitbucket repository. By providing the workspace identifier, repository slug, pipeline UUID, and step UUID as path parameters, developers can access detailed information about individual test cases that were executed during that particular pipeline step, including test names, status (passed, failed, skipped), execution time, and any associated error messages or stack traces. This endpoint is particularly useful for analyzing test failures, generating custom reports, or integrating Bitbucket pipeline test results into external monitoring and quality assurance tools. x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons : get: tags: - Get summary: Atlassian Get Test Case Reasons (output) for Given Test Case in Step of Pipeline. operationId: getTestCaseReasonsOutputForGivenTestCaseInStepOfPipeline 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 - name: step_uuid description: The UUID of the step. required: true in: path schema: type: string - name: test_case_uuid description: The UUID of the test case. required: true in: path schema: type: string responses: '200': description: Test case reasons (output). '404': description: No account, repository, pipeline, step or test case with the UUID provided exists for the pipeline with the UUID provided. 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: [] description: This API endpoint retrieves the test case reasons (output) for a specific test case within a pipeline step in Atlassian Bitbucket. It requires authentication and accepts path parameters including the workspace identifier, repository slug, pipeline UUID, step UUID, and test case UUID to uniquely identify the test case whose reasons or failure details you want to access. The GET operation returns information about why a particular test case passed, failed, or was skipped during the execution of that specific pipeline step, providing detailed diagnostic information useful for debugging automated test failures in your CI/CD pipeline. x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/pipelines_config: get: tags: - Get summary: Atlassian Get Configuration description: This API operation retrieves the Pipelines configuration for a specific Bitbucket repository within a workspace. By making a GET request to the endpoint with the appropriate workspace ID and repository slug parameters, users can access the current pipeline settings and configuration details that define how Bitbucket Pipelines behaves for that particular repository. This includes information about build configurations, deployment settings, and any custom pipeline definitions that have been established, allowing developers and administrators to programmatically view and verify the CI/CD setup without accessing the repository settings through the web interface. operationId: getConfiguration 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 repository pipelines configuration. content: application/json: schema: $ref: '#/components/schemas/pipelines_config' examples: pipelines-configuration: $ref: '#/components/examples/pipelines-configuration' x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - admin:repository:bitbucket security: - oauth2: - repository:admin - 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}: get: tags: - Get summary: Atlassian Get Schedule description: This API operation retrieves the details of a specific pipeline schedule for a Bitbucket repository. By providing the workspace identifier, repository slug, and the unique UUID of the schedule, you can fetch information about an automated pipeline execution schedule, including its configuration, timing settings, enabled status, and associated branch or target. This endpoint is useful for reviewing existing pipeline automation settings and understanding when and how pipelines are configured to run automatically within a specific repository. operationId: getSchedule 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 requested schedule. content: application/json: schema: $ref: '#/components/schemas/pipeline_schedule' examples: pipeline-schedule_2: $ref: '#/components/examples/pipeline-schedule_2' '404': description: The account, repository or schedule 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/key_pair: get: tags: - Get summary: Atlassian Get Ssh Key Pair description: Retrieves the SSH key pair configured for Bitbucket Pipelines in a specific repository within a workspace. This endpoint returns the public and private SSH key that Pipelines uses to authenticate and access external resources during build and deployment processes. The key pair enables secure connections to remote servers, allowing pipelines to perform operations like deploying code or accessing private dependencies. Authentication is required to access this endpoint, and the requesting user must have appropriate permissions on the repository to view its pipeline configuration settings. operationId: getSshKeyPair 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 SSH key pair. content: application/json: schema: $ref: '#/components/schemas/pipeline_ssh_key_pair' examples: pipeline-ssh-key-pair: $ref: '#/components/examples/pipeline-ssh-key-pair' '404': description: The account, repository or SSH key pair 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/{known_host_uuid}: get: tags: - Get summary: Atlassian Get Known Host description: This GET operation retrieves a specific known host entry from a Bitbucket repository's Pipelines SSH configuration using the known host's unique identifier. The endpoint requires the workspace name, repository slug, and the UUID of the known host to return detailed information about that particular SSH known host entry, which is used to verify and establish secure SSH connections during pipeline executions. This allows administrators and developers to inspect individual known host configurations that have been added to the repository's Pipelines settings for secure server authentication. operationId: getKnownHost 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: known_host_uuid description: The UUID of the known host to retrieve. required: true in: path schema: type: string responses: '200': description: The known host. content: application/json: schema: $ref: '#/components/schemas/pipeline_known_host' examples: pipeline-known-host_2: $ref: '#/components/examples/pipeline-known-host_2' '404': description: The account, repository or known host with the specified UUID 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/variables/{variable_uuid}: get: tags: - Get summary: Atlassian Get Variable for Repository description: This API operation retrieves a specific pipeline variable for a Bitbucket repository by its unique identifier. It requires authentication and access to the specified workspace and repository, using the repository slug and variable UUID as path parameters. The endpoint returns the complete details of the requested pipeline variable, including its name, value, security settings, and other configuration metadata that controls how the variable is used within the repository's CI/CD pipelines. operationId: getVariableForRepository 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: variable_uuid description: The UUID of the variable to retrieve. required: true in: path schema: type: string responses: '200': description: The variable. content: application/json: schema: $ref: '#/components/schemas/pipeline_variable' examples: pipeline-variable_2: $ref: '#/components/examples/pipeline-variable_2' '404': description: The account, repository or variable with the specified UUID 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}/properties/{app_key}/{property_name}: get: responses: '200': description: The value of the property. content: application/json: schema: $ref: '#/components/schemas/application_property' examples: application-property_2: $ref: '#/components/examples/application-property_2' operationId: getRepositoryApplicationProperty summary: Atlassian Get Repository Application Property description: This API operation retrieves a specific application property stored against a Bitbucket repository within a given workspace. By providing the workspace identifier, repository slug, application key, and property name as path parameters, developers can fetch custom metadata or configuration values that have been previously set by an application for that particular repository. This is useful for applications that need to store and retrieve repository-specific settings or data, such as integration configurations, feature flags, or custom attributes that extend the repository's functionality beyond Bitbucket's native features. parameters: - required: true in: path name: workspace description: The repository container; either the workspace slug or the UUID in curly braces. schema: type: string - required: true in: path name: repo_slug description: The repository. schema: type: string - required: true in: path name: app_key description: The key of the Connect app. schema: type: string - required: true in: path name: property_name description: The name of the property. schema: type: string tags: - Get security: - oauth2: [] - 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/branches/{name}: parameters: - name: name in: path description: The name of the branch. 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: - Get description: This API operation retrieves detailed information about a specific branch within a Bitbucket repository. By providing the workspace identifier, repository slug, and branch name in the endpoint path, users can fetch comprehensive data about the target branch including its latest commit details, author information, commit hash, and other branch-specific metadata. This is particularly useful for applications that need to programmatically access branch information for CI/CD pipelines, deployment workflows, or repository management tasks without having to clone the entire repository or traverse the full commit history. summary: Atlassian Get Branch responses: '200': description: The branch object. content: application/json: schema: $ref: '#/components/schemas/branch' examples: response: value: name: master links: commits: href: https://api.bitbucket.org/2.0/repositories/atlassian/aui/commits/master self: href: https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches/master html: href: https://bitbucket.org/atlassian/aui/branch/master default_merge_strategy: squash merge_strategies: - merge_commit - squash - fast_forward type: branch target: hash: e7d158ff7ed5538c28f94cd97a9ad569680fc94e repository: links: self: href: https://api.bitbucket.org/2.0/repositories/atlassian/aui html: href: https://bitbucket.org/atlassian/aui avatar: href: https://bytebucket.org/ravatar/%7B585074de-7b60-4fd1-81ed-e0bc7fafbda5%7D?ts=86317 type: repository name: aui full_name: atlassian/aui uuid: '{585074de-7b60-4fd1-81ed-e0bc7fafbda5}' links: self: href: https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e comments: href: https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e/comments patch: href: https://api.bitbucket.org/2.0/repositories/atlassian/aui/patch/e7d158ff7ed5538c28f94cd97a9ad569680fc94e html: href: https://bitbucket.org/atlassian/aui/commits/e7d158ff7ed5538c28f94cd97a9ad569680fc94e diff: href: https://api.bitbucket.org/2.0/repositories/atlassian/aui/diff/e7d158ff7ed5538c28f94cd97a9ad569680fc94e approve: href: https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e/approve statuses: href: https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e/statuses author: raw: psre-renovate-bot type: author user: display_name: psre-renovate-bot uuid: '{250a442a-3ab3-4fcb-87c3-3c8f3df65ec7}' links: self: href: https://api.bitbucket.org/2.0/users/%7B250a442a-3ab3-4fcb-87c3-3c8f3df65ec7%7D html: href: https://bitbucket.org/%7B250a442a-3ab3-4fcb-87c3-3c8f3df65ec7%7D/ avatar: href: https://secure.gravatar.com/avatar/6972ee037c9f36360170a86f544071a2?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FP-3.png nickname: Renovate Bot type: user account_id: 5d5355e8c6b9320d9ea5b28d parents: - hash: eab868a309e75733de80969a7bed1ec6d4651e06 type: commit links: self: href: https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/eab868a309e75733de80969a7bed1ec6d4651e06 html: href: https://bitbucket.org/atlassian/aui/commits/eab868a309e75733de80969a7bed1ec6d4651e06 date: '2021-04-12T06:44:38+00:00' message: 'Merged in issue/NONE-renovate-master-babel-monorepo (pull request #2883) chore(deps): update babel monorepo to v7.13.15 (master) Approved-by: Chris "Daz" Darroch ' type: commit '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 or branch 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: getBranch x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/refs/tags/{name}: parameters: - name: name in: path description: The name of the tag. 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: - Get description: This API operation retrieves detailed information about a specific tag in a Bitbucket repository by providing the workspace identifier, repository slug, and tag name as path parameters. When called with a GET request, it returns metadata about the specified tag including its name, target commit hash, creation date, associated message, and tagger information. This endpoint is useful for applications that need to programmatically access tag details for version management, release tracking, or deployment automation purposes within Bitbucket repositories. summary: Atlassian Get Tag responses: '200': description: The tag object. content: application/json: schema: $ref: '#/components/schemas/tag' examples: tag_2: $ref: '#/components/examples/tag_2' '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 or tag 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: getTag x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/src: 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: - Get description: The GET operation on /repositories/{workspace}/{repo_slug}/src endpoint in the Atlassian Bitbucket Repositories API retrieves the contents of the root directory from the main branch of a specified repository. By providing the workspace identifier and repository slug in the path parameters, this endpoint returns a paginated list of files and directories located at the repository's root level, including metadata such as file names, paths, sizes, and commit information. This operation is useful for browsing repository structure, displaying directory contents in user interfaces, or programmatically navigating through repository files without cloning the entire repository locally. summary: Atlassian Get the Root Directory of the Main Branch responses: '200': description: 'If the path matches a file, then the raw contents of the file are returned (unless the `format=meta` query parameter was provided, in which case a json document containing the file''s meta data is returned). If the path matches a directory, then a paginated list of file and directory entries is returned (if the `format=meta` query parameter was provided, then the json document containing the directory''s meta data is returned). ' content: application/json: schema: $ref: '#/components/schemas/paginated_treeentries' examples: paginated-tree-entry: $ref: '#/components/examples/paginated-tree-entry' '404': description: If the path or commit in the URL does not exist. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: format in: query description: Instead of returning the file's contents, return the (json) meta data for it. required: false schema: type: string enum: - meta security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: getTheRootDirectoryOfTheMainBranch x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/src/{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: - Get description: This GET operation retrieves the raw content of a file or the contents of a directory from a specific Bitbucket repository at a particular commit. By providing the workspace identifier, repository slug, commit hash or branch name, and the file or directory path, users can access the exact state of their source code at any point in the repository's history. When targeting a file, the endpoint returns the raw file content, while targeting a directory returns a listing of its contents including files and subdirectories with their metadata, making it essential for browsing repository structure, retrieving specific versions of files, or implementing custom code review and analysis tools. summary: Atlassian Get File or Directory Contents responses: '200': description: 'If the path matches a file, then the raw contents of the file are returned. If the `format=meta` query parameter is provided, a json document containing the file''s meta data is returned. If the `format=rendered` query parameter is provided, the contents of the file in HTML-formated rendered markup is returned. If the path matches a directory, then a paginated list of file and directory entries is returned (if the `format=meta` query parameter was provided, then the json document containing the directory''s meta data is returned.) ' content: application/json: schema: $ref: '#/components/schemas/paginated_treeentries' examples: paginated-tree-entry_2: $ref: '#/components/examples/paginated-tree-entry_2' '404': description: If the path or commit in the URL does not exist. content: application/json: schema: $ref: '#/components/schemas/error' '555': description: If the call times out, possibly because the specified recursion depth is too large. content: application/json: schema: $ref: '#/components/schemas/error' parameters: - name: format in: query description: 'If ''meta'' is provided, returns the (json) meta data for the contents of the file. If ''rendered'' is provided, returns the contents of a non-binary file in HTML-formatted rendered markup. The ''rendered'' option only supports these filetypes: `.md`, `.markdown`, `.mkd`, `.mkdn`, `.mdown`, `.text`, `.rst`, and `.textile`. Since Git does not generally track what text encoding scheme is used, this endpoint attempts to detect the most appropriate character encoding. While usually correct, determining the character encoding can be ambiguous which in exceptional cases can lead to misinterpretation of the characters. As such, the raw element in the response object should not be treated as equivalent to the file''s actual contents.' required: false schema: type: string enum: - meta - rendered - name: q in: query description: Optional filter expression as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). required: false schema: type: string - name: sort in: query description: Optional sorting parameter as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results). required: false schema: type: string - name: max_depth in: query description: If provided, returns the contents of the repository and its subdirectories recursively until the specified max_depth of nested directories. When omitted, this defaults to 1. required: false schema: type: integer security: - oauth2: - repository - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - read:repository:bitbucket operationId: getFileOrDirectoryContents x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /repositories/{workspace}/{repo_slug}/versions/{version_id}: 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: version_id in: path description: The version's id required: true schema: type: integer - 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: - Get description: 'This GET operation retrieves a specific defined version for issues within a Bitbucket repository by accessing the endpoint /repositories/{workspace}/{repo_slug}/versions/{version_id}. It requires three path parameters: the workspace identifier, the repository slug (a URL-friendly repository name), and the version_id of the specific version you want to retrieve. This endpoint is useful for fetching detailed information about a particular version or milestone that has been configured for issue tracking within a Bitbucket repository, allowing developers and project managers to access version-specific metadata, release information, and associated issue tracking details programmatically.' summary: Atlassian Get Defined Version for Issues responses: '200': description: The specified version object. content: application/json: schema: $ref: '#/components/schemas/version' examples: version: $ref: '#/components/examples/version' '404': description: The specified repository or version 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: getDefinedVersionForIssues x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}/{encoded_id}: 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: - Get description: The Get Snippet operation retrieves a specific snippet from Atlassian Bitbucket by providing the workspace identifier and the encoded snippet ID in the request path. This API endpoint returns detailed information about a single code snippet, including its content, metadata, creation date, author information, and any associated files or comments. Users must have appropriate read permissions for the workspace to access the snippet, and the operation supports various authentication methods including OAuth 2.0 and HTTP basic authentication. The response includes the Snippets title, description, programming language, visibility settings (public or private), and the actual code content, making it useful for integrating snippet management functionality into external applications or automating snippet retrieval workflows. summary: Atlassian Get Snippet responses: '200': description: The snippet object. content: application/json: schema: $ref: '#/components/schemas/snippet' examples: snippet_2: $ref: '#/components/examples/snippet_2' multipart/related: schema: $ref: '#/components/schemas/snippet' multipart/form-data: schema: $ref: '#/components/schemas/snippet' '401': description: If the snippet is private and the request was not authenticated. content: application/json: schema: $ref: '#/components/schemas/error' multipart/related: schema: $ref: '#/components/schemas/error' multipart/form-data: schema: $ref: '#/components/schemas/error' '403': description: If authenticated user does not have access to the private snippet. content: application/json: schema: $ref: '#/components/schemas/error' multipart/related: schema: $ref: '#/components/schemas/error' multipart/form-data: schema: $ref: '#/components/schemas/error' '404': description: If the snippet does not exist. content: application/json: schema: $ref: '#/components/schemas/error' multipart/related: schema: $ref: '#/components/schemas/error' multipart/form-data: schema: $ref: '#/components/schemas/error' '410': description: If the snippet marked as spam. content: application/json: schema: $ref: '#/components/schemas/error' multipart/related: schema: $ref: '#/components/schemas/error' multipart/form-data: 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: getSnippet x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}/{encoded_id}/comments/{comment_id}: parameters: - name: comment_id in: path description: The id of the comment. required: true schema: type: integer - 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: - Get description: This API operation retrieves a specific comment from a snippet in Atlassian Bitbucket by providing the workspace identifier, the encoded snippet ID, and the comment ID as path parameters. It performs a GET request to access the detailed information about an individual comment that was previously posted on a snippet, allowing users to view the comment's content, author details, timestamps, and other metadata associated with that particular comment within the specified workspace and snippet context. summary: Atlassian Get Comment on Snippet responses: '200': description: The specified comment. content: application/json: schema: $ref: '#/components/schemas/snippet_comment' examples: snippet-comment_2: $ref: '#/components/examples/snippet-comment_2' '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 comment or 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: getCommentOnSnippet x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}/{encoded_id}/commits/{revision}: parameters: - name: encoded_id in: path description: The snippet id. required: true schema: type: string - name: revision in: path description: The commit's SHA1. 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: - Get description: This API endpoint retrieves a specific previous version of a snippet by accessing its commit history in Atlassian Bitbucket. By providing the workspace identifier, the Snippets encoded ID, and a specific revision hash, users can fetch the exact state of a snippet as it existed at that particular commit. This is useful for tracking changes over time, reviewing historical versions of code snippets, auditing modifications, or restoring previous content. The endpoint returns detailed information about the Snippets content and metadata at the specified revision, enabling version control functionality for snippets stored within a Bitbucket workspace. summary: Atlassian Get Previous Snippet Change responses: '200': description: The specified snippet commit. content: application/json: schema: $ref: '#/components/schemas/snippet_commit' examples: snippet-commit: $ref: '#/components/examples/snippet-commit' '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 commit or 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: getPreviousSnippetChange x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}/{encoded_id}/files/{path}: parameters: - name: encoded_id in: path description: The snippet id. required: true schema: type: string - name: path in: path description: Path to the file. 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: - Get description: Retrieves the raw, unrendered content of a specific file from a snippet at its latest HEAD revision in Atlassian Bitbucket. This endpoint requires specifying the workspace identifier, the encoded snippet ID, and the full path to the file within the snippet's file structure. The operation returns the file's content in its original format without any Bitbucket rendering or formatting applied, making it useful for programmatically accessing snippet files for download, processing, or display in external applications. Authentication is typically required based on the snippet's visibility settings, with private snippets requiring appropriate permissions to access the raw file content. summary: Atlassian Get Snippets Raw File at Head responses: '302': description: A redirect to the most recent revision of the specified file. headers: Location: description: The URL of the most recent file revision. schema: type: string '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 operationId: getSnippetsRawFileAtHead x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}/{encoded_id}/{node_id}: parameters: - name: encoded_id in: path description: The snippet id. required: true schema: type: string - name: node_id in: path description: A commit revision (SHA1). 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: - Get description: This API operation retrieves a specific previous revision of a snippet in Atlassian Bitbucket by providing the workspace identifier, the encoded snippet ID, and the node ID representing the particular revision you want to access. It allows users to view historical versions of code snippets, enabling them to track changes, compare different iterations, or restore earlier versions of their snippet content. The endpoint requires three path parameters to uniquely identify both the snippet and its specific revision within the workspace's collection of snippets. summary: Atlassian Get Previous Revision of Snippet responses: '200': description: The snippet object. content: application/json: schema: $ref: '#/components/schemas/snippet' examples: snippet_2: $ref: '#/components/examples/snippet_2' multipart/related: schema: $ref: '#/components/schemas/snippet' multipart/form-data: schema: $ref: '#/components/schemas/snippet' '401': description: If the snippet is private and the request was not authenticated. content: application/json: schema: $ref: '#/components/schemas/error' multipart/related: schema: $ref: '#/components/schemas/error' multipart/form-data: schema: $ref: '#/components/schemas/error' '403': description: If authenticated user does not have access to the private snippet. content: application/json: schema: $ref: '#/components/schemas/error' multipart/related: schema: $ref: '#/components/schemas/error' multipart/form-data: schema: $ref: '#/components/schemas/error' '404': description: If the snippet, or the revision does not exist. content: application/json: schema: $ref: '#/components/schemas/error' multipart/related: schema: $ref: '#/components/schemas/error' multipart/form-data: 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: getPreviousRevisionOfSnippet x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}/{encoded_id}/{node_id}/files/{path}: parameters: - name: encoded_id in: path description: The snippet id. required: true schema: type: string - name: node_id in: path description: A commit revision (SHA1). required: true schema: type: string - name: path in: path description: Path to the file. 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: - Get description: This API operation retrieves the raw content of a specific file within a particular revision of a Bitbucket snippet. By providing the workspace identifier, the encoded snippet ID, a specific node ID (representing a commit or revision), and the file path, you can access the unprocessed file content directly. This is particularly useful when you need to programmatically fetch the exact contents of a snippet file at a specific point in its version history, whether for display purposes, downloading, or further processing in your application. summary: Atlassian Get Snippets Raw File responses: '200': description: Returns the contents of the specified file. headers: Content-Type: description: The mime type as derived from the filename schema: type: string Content-Disposition: description: attachment schema: type: string '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 file or 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 operationId: getSnippetsRawFile x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}/{encoded_id}/{revision}/diff: parameters: - name: encoded_id in: path description: The snippet id. required: true schema: type: string - name: revision in: path description: A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like `staging..production`. 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: - Get description: This API endpoint retrieves the differences between two versions of a snippet in Atlassian Bitbucket by comparing a specified revision against its parent or another revision. It accepts the workspace identifier, the encoded snippet ID, and a revision hash as path parameters, allowing users to view what content has changed between versions of a code snippet. The response typically returns a unified diff format showing the additions, deletions, and modifications made to the snippet's content, which is useful for tracking changes, reviewing edits, or understanding the evolution of a code snippet over time within a Bitbucket workspace. summary: Atlassian Get Snippet Changes Between Versions responses: '200': description: The raw diff contents. '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' parameters: - name: path in: query description: When used, only one the diff of the specified file will be returned. schema: type: string security: - oauth2: - snippet - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true operationId: getSnippetChangesBetweenVersions x-microcks-operation: delay: 0 dispatcher: FALLBACK /snippets/{workspace}/{encoded_id}/{revision}/patch: parameters: - name: encoded_id in: path description: The snippet id. required: true schema: type: string - name: revision in: path description: A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like `staging..production`. 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: - Get description: This API endpoint retrieves a unified diff or patch representation of changes made to a specific snippet between different revisions in Atlassian Bitbucket. By providing the workspace identifier, encoded snippet ID, and a revision specifier, users can obtain a detailed comparison showing the line-by-line differences between the specified revision and its predecessor, formatted as a standard patch file that can be applied using tools like git or diff utilities, making it useful for tracking changes, code reviews, or understanding the evolution of code snippets over time. summary: Atlassian Get Snippet Patch Between Versions responses: '200': description: The raw patch contents. '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 operationId: getSnippetPatchBetweenVersions x-microcks-operation: delay: 0 dispatcher: FALLBACK /teams/{username}/pipelines_config/variables/{variable_uuid}: get: tags: - Get deprecated: true summary: Atlassian Get Variable for Team description: This API operation retrieves detailed information about a specific pipeline variable configured at the team level in Bitbucket. By providing the Teams username and the unique identifier (UUID) of the variable, you can fetch the variable's configuration details including its name, value, security settings, and other metadata. This is particularly useful when you need to inspect or validate existing pipeline variables that are shared across all repositories within a team, allowing administrators to manage and audit environment variables, credentials, or other configuration values used during the CI/CD pipeline execution process. operationId: getVariableForTeam parameters: - name: username description: The account. required: true in: path schema: type: string - name: variable_uuid description: The UUID of the variable to retrieve. required: true in: path schema: type: string responses: '200': description: The variable. content: application/json: schema: $ref: '#/components/schemas/pipeline_variable' examples: pipeline-variable_2: $ref: '#/components/examples/pipeline-variable_2_2' '404': description: The account or variable with the given UUID was not found. content: application/json: schema: $ref: '#/components/schemas/error' 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: parameters: [] get: tags: - Get description: The Atlassian Bitbucket User API's GET /user endpoint retrieves detailed information about the currently authenticated user making the request. This operation returns a user object containing profile data such as the Users display name, username, account ID, avatar URL, and other associated account details. Authentication is required to access this endpoint, typically using OAuth 2.0, Basic Authentication with app passwords, or personal access tokens. The response provides comprehensive information about the authenticated Users account, making it useful for applications that need to display user profile information, verify user identity, or customize the user experience based on the current Users account details. summary: Atlassian Get Current User responses: '200': description: The current user. content: application/json: schema: $ref: '#/components/schemas/account' examples: account: $ref: '#/components/examples/account_3' '401': description: When the request wasn't authenticated. 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 GenerateExampleFromOperationResponseSchema: true operationId: getCurrentUser x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/emails/{email}: parameters: - name: email in: path description: Email address of the user. required: true schema: type: string get: tags: - Get description: This API operation retrieves information about a specific email address associated with the currently authenticated Bitbucket user. By making a GET request to the endpoint with a particular email address as a path parameter, users can verify whether that email belongs to their account and obtain related metadata such as confirmation status and whether it's set as the primary email. This is useful for applications that need to validate or manage email addresses linked to a Users Bitbucket account, allowing developers to programmatically check email ownership and configuration details without requiring manual inspection of account settings. summary: Atlassian Get an Email Address 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 operationId: getAnEmailAddressForCurrentUser x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/{selected_user}: 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: - Get description: The Atlassian Bitbucket User API endpoint /users/{selected_user} with the GET method retrieves detailed information about a specific user account within Bitbucket. By providing a username as the path parameter {selected_user}, this operation returns comprehensive user profile data including the Users display name, account ID, avatar URL, account status, and other publicly available information associated with that Users Bitbucket account. This endpoint is commonly used to fetch user details for display purposes, validate user existence, or integrate user information into external applications and workflows that interact with Bitbucket repositories and teams. summary: Atlassian Get User responses: '200': description: The user object content: application/json: schema: $ref: '#/components/schemas/account' examples: account_2: $ref: '#/components/examples/account_2' '404': description: If no user exists for the specified UUID, or if the specified account is a team account, not a personal account. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: [] - basic: [] - api_key: [] x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true operationId: getUser x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/{selected_user}/pipelines_config/variables/{variable_uuid}: get: tags: - Get deprecated: true summary: Atlassian Get Variable for User description: This API operation retrieves a specific pipeline configuration variable for a given Bitbucket user by providing both the user identifier and the unique variable UUID. It allows administrators or authorized users to fetch details about an individual pipeline variable that has been configured at the user account level, which can include information such as the variable's key, value, secured status, and other metadata. This is useful when you need to inspect or verify the configuration of a specific variable without retrieving all variables associated with the Users pipeline configuration. operationId: getVariableForUser 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 - name: variable_uuid description: The UUID of the variable to retrieve. required: true in: path schema: type: string responses: '200': description: The variable. content: application/json: schema: $ref: '#/components/schemas/pipeline_variable' examples: pipeline-variable_2: $ref: '#/components/examples/pipeline-variable_2_3' '404': description: The account or variable with the given UUID was not found. content: application/json: schema: $ref: '#/components/schemas/error' 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}/properties/{app_key}/{property_name}: get: responses: '200': description: The value of the property. content: application/json: schema: $ref: '#/components/schemas/application_property' examples: application-property: $ref: '#/components/examples/application-property_4' operationId: getUserApplicationProperty summary: Atlassian Get User Application Property description: 'The Get User Application Property operation retrieves a specific application property associated with a particular Bitbucket user. This endpoint requires three path parameters: the selected_user identifier, an app_key that identifies the application storing the property, and the property_name which specifies the exact property to retrieve. Application properties are key-value pairs that applications can store against user accounts for configuration, preferences, or other application-specific data. When called, this GET operation returns the value of the requested property if it exists, allowing applications to read previously stored user-specific settings or metadata. This is commonly used by Bitbucket apps and integrations to maintain user-level configuration data without requiring separate database infrastructure.' parameters: - required: true in: path name: selected_user description: Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID. schema: type: string - required: true in: path name: app_key description: The key of the Connect app. schema: type: string - required: true in: path name: property_name description: The name of the property. schema: type: string tags: - Get security: - oauth2: [] - 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/{key_id}: parameters: - name: key_id in: path description: The SSH key's UUID value. required: true schema: type: string - 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: - Get description: This API operation retrieves a specific SSH key associated with a particular Bitbucket user by providing both the username and the unique key identifier in the request path. When executed, it returns detailed information about the specified SSH key, including its public key value, label, and other metadata. This endpoint is useful for administrators or applications that need to verify or audit SSH keys configured for user accounts, enabling secure authentication and repository access management within Bitbucket. summary: Atlassian Get Ssh Key responses: '200': description: The specific SSH key matching the user and UUID content: application/json: schema: $ref: '#/components/schemas/ssh_account_key' examples: ssh-account-key_2: $ref: '#/components/examples/ssh-account-key_2' '403': description: If the specified user or key is not accessible to the current user '404': description: If the specified user or key 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 GenerateExampleFromOperationResponseSchema: true operationId: getSshKey x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/projects/{project_key}/permissions-config/users/{selected_user_id}: 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: selected_user_id in: path description: 'This can either be the username, the Users UUID surrounded by curly-braces, for example: {account UUID}, or the Users Atlassian 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: - Get description: 'Retrieves the explicit permission details for a specific user within a designated project in a Bitbucket workspace. This endpoint requires three path parameters: the workspace slug identifying the Bitbucket workspace, the project key for the specific project, and the selected user ID representing the user whose permissions are being queried. When called, it returns the permission level that has been directly assigned to the specified user for that project, excluding any inherited permissions from groups or workspace-level access. This is useful for auditing individual user access rights, verifying specific permission assignments, or displaying user-level access information in administrative interfaces.' summary: Atlassian Get an Explicit User Permission for Project responses: '200': description: Explicit user permission for user and project content: application/json: schema: $ref: '#/components/schemas/project_user_permission' examples: project-user-permission: $ref: '#/components/examples/project-user-permission' '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 project. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: One or more of the workspace, project, and selected user doesn'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: getAnExplicitUserPermissionForProject x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{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: - Get description: This API operation retrieves detailed information about a specific workspace by making a GET request to the endpoint /workspaces/{workspace}, where {workspace} is a path parameter representing the unique identifier of the workspace you want to access. When executed, it returns the complete data and configuration settings associated with that particular workspace, allowing users or applications to view workspace properties, metadata, and current state information without making any modifications to the workspace itself. summary: Atlassian Get a Workspace responses: '200': description: The workspace. content: application/json: schema: $ref: '#/components/schemas/workspace' examples: workspace: $ref: '#/components/examples/workspace' '404': description: If no workspace exists for the specified name or UUID. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: [] - basic: [] - api_key: [] operationId: atlassianGetAWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/hooks/{uid}: parameters: - name: uid in: path description: Installed webhook's 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: - Get description: This API operation retrieves detailed information about a specific webhook configured for an Atlassian Bitbucket workspace. By providing the workspace identifier and the unique webhook ID (uid) in the endpoint path, you can fetch the webhook's configuration details including its URL, events it subscribes to, active status, and other metadata. This is useful for verifying webhook settings, auditing workspace integrations, or programmatically managing webhook configurations within your Bitbucket workspace. summary: Atlassian Get a Webhook for a Workspace responses: '200': description: The webhook subscription object. content: application/json: schema: $ref: '#/components/schemas/webhook_subscription' examples: webhook-subscription_2: $ref: '#/components/examples/webhook-subscription_2_2' '404': description: If the webhook or workspace does not exist. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - webhook - basic: [] - api_key: [] operationId: atlassianGetAWebhookForAWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/members/{member}: parameters: - name: member in: path description: Member's UUID or Atlassian 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: - Get description: This GET operation retrieves detailed information about a specific user's membership within a designated Bitbucket workspace. By providing the workspace identifier and member identifier in the URL path parameters, the API returns the membership details for that particular user, including their role, permissions, and associated account information within the context of the specified workspace. This endpoint is useful for administrators and applications that need to verify a user's access level, check membership status, or retrieve specific member details for workspace management purposes. summary: Atlassian Get User Membership for a Workspace responses: '200': description: The user that is part of a workspace. content: application/json: schema: $ref: '#/components/schemas/workspace_membership' examples: workspace-membership: $ref: '#/components/examples/workspace-membership' '401': description: The request wasn't authenticated. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: A workspace cannot be found, or a user cannot be found, or the user is not a a member of the workspace. 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: atlassianGetUserMembershipForAWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configuration: get: tags: - Get summary: Atlassian Get Openid Configuration for Oidc in Pipelines description: This API endpoint retrieves the OpenID Connect (OIDC) configuration for Bitbucket Pipelines within a specified workspace. It returns the well-known OpenID configuration document that contains metadata about the OIDC identity provider used by Pipelines, including supported endpoints, token signing algorithms, claims, and other OAuth 2.0 and OIDC protocol details. This configuration is essential for external services and cloud providers that need to establish trust and validate identity tokens issued by Bitbucket Pipelines when using OIDC authentication for secure, keyless deployments without storing long-lived credentials. operationId: atlassianGetoidcconfiguration 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 OpenID configuration '404': description: The workspace was not found. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: [] - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/pipelines-config/identity/oidc/keys.json: get: tags: - Get summary: Atlassian Get Keys for Oidc in Pipelines description: This API endpoint retrieves the JSON Web Key Set (JWKS) containing the public keys used for OpenID Connect (OIDC) authentication in Bitbucket Pipelines for a specific workspace. It accepts a GET request to the path /workspaces/{workspace}/pipelines-config/identity/oidc/keys.json, where {workspace} is replaced with the workspace ID or slug. The endpoint returns a keys.json file that contains cryptographic keys used to verify JWT tokens issued by Bitbucket Pipelines' OIDC provider, enabling secure identity federation between Pipelines and external services that support OIDC authentication. operationId: atlassianGetoidckeys 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 keys in JSON web key format '404': description: The workspace was not found. content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: [] - basic: [] - api_key: [] x-api-evangelist-processing: WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/pipelines-config/variables/{variable_uuid}: get: tags: - Get summary: Atlassian Get Variable for a Workspace description: This API operation retrieves detailed information about a specific pipeline variable configured for a Bitbucket workspace by providing the workspace identifier and the unique UUID of the variable. It allows developers to programmatically access the configuration details of environment variables, secrets, or other pipeline variables that have been set up at the workspace level, which can be used across multiple repositories within that workspace. The endpoint returns the variable's metadata including its key, value (if not secured), type, and whether it's secured or not, making it useful for auditing pipeline configurations or integrating workspace-level pipeline settings into automated workflows and deployment processes. operationId: atlassianGetpipelinevariableforworkspace 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: variable_uuid description: The UUID of the variable to retrieve. required: true in: path schema: type: string responses: '200': description: The variable. content: application/json: schema: $ref: '#/components/schemas/pipeline_variable' examples: pipeline-variable_2: $ref: '#/components/examples/pipeline-variable_2_4' '404': description: The workspace or variable with the given UUID 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 /workspaces/{workspace}/projects/{project_key}: 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: - Get description: 'The Get A Project For A Workspace operation in the Atlassian Bitbucket Workspaces API retrieves detailed information about a specific project within a designated workspace by making a GET request to the endpoint /workspaces/{workspace}/projects/{project_key}. This operation requires two path parameters: the workspace identifier (which can be the workspace''s UUID, ID, or slug) and the project_key (a unique identifier for the project within that workspace). When successfully invoked, it returns comprehensive project details including the project''s name, description, key, creation date, visibility settings, owner information, associated links, and other metadata. This endpoint is commonly used by developers and integrations to fetch project-level configuration data, validate project existence, or retrieve project attributes before performing additional operations within that project''s scope.' summary: Atlassian Get a Project for a Workspace responses: '200': description: The project that is part of a workspace. content: application/json: schema: $ref: '#/components/schemas/project' examples: project_2: $ref: '#/components/examples/project_2' '401': description: The request wasn't authenticated. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: The requesting user isn't authorized to access the project. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: A project isn't hosted 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: atlassianGetAProjectForAWorkspace x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/projects/{project_key}/branching-model: 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: - Get description: This API operation retrieves the branching model configuration for a specific project within a Bitbucket workspace, allowing you to understand how branches are organized and managed within that project. By providing the workspace identifier and project key as path parameters, the GET request returns details about the project's branching strategy, which may include information about development branches, production branches, branch prefixes, and the overall workflow structure that defines how code changes flow from development to production. This is particularly useful for teams that want to programmatically access or audit their project's Git workflow configuration, integrate branching model information into CI/CD pipelines, or build custom tooling that needs to understand the project's branch organization scheme. summary: Atlassian Get the Branching Model for a Project responses: '200': description: The branching model object content: application/json: schema: $ref: '#/components/schemas/project_branching_model' examples: project-branching-model: $ref: '#/components/examples/project-branching-model' '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 read access to the project content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the project does not exist 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:repository:bitbucket operationId: atlassianGetTheBranchingModelForAProject x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/projects/{project_key}/branching-model/settings: 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: - Get description: This API endpoint retrieves the branching model configuration settings for a specific project within a designated workspace in Atlassian Bitbucket. By making a GET request to this endpoint with the appropriate workspace identifier and project key, users can access the project's branching strategy configuration, which typically includes details about branch types, naming conventions, and workflow patterns such as Git Flow or similar branching models. This information helps teams understand and maintain consistent branching practices across their repositories within the project, ensuring standardized development workflows and version control strategies. summary: Atlassian Get the Branching Model Config for a Project responses: '200': description: The branching model configuration content: application/json: schema: $ref: '#/components/schemas/branching_model_settings' examples: branching-model-settings: $ref: '#/components/examples/branching-model-settings' '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 project content: application/json: schema: $ref: '#/components/schemas/error' '404': description: If the project does not exist content: application/json: schema: $ref: '#/components/schemas/error' security: - oauth2: - project:admin - basic: [] - api_key: [] x-atlassian-oauth2-scopes: - state: Current scheme: oauth2 scopes: - admin:project:bitbucket operationId: atlassianGetTheBranchingModelConfigForAProject x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}: parameters: - name: project_key in: path description: 'The project in question. This can either be the actual `key` assigned to the project or the `UUID` (surrounded by curly-braces (`{}`)). ' required: true schema: type: string - name: selected_user in: path description: 'This can either be the username or the UUID of the default reviewer, surrounded by curly-braces, for example: `{account 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: - Get description: This GET operation retrieves information about a specific default reviewer for a project within a Bitbucket workspace. By providing the workspace identifier, project key, and the selected user's identifier in the endpoint path, the API returns details about that user's default reviewer configuration for the specified project. Default reviewers are automatically added to pull requests created within the project, streamlining the code review process by ensuring appropriate team members are notified of new changes. This endpoint is useful for auditing reviewer assignments, verifying default reviewer settings, or building administrative interfaces that manage project-level review workflows in Bitbucket. summary: Atlassian Get a Default Reviewer responses: '200': description: The specified user that is a default reviewer content: application/json: schema: $ref: '#/components/schemas/user' examples: user: $ref: '#/components/examples/user' '400': description: If the specified user is not a default reviewer for the project content: application/json: schema: $ref: '#/components/schemas/error' '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 specified user, project, or workspace does not exist 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: atlassianGetADefaultReviewer x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspace}/projects/{project_key}/deploy-keys/{key_id}: parameters: - name: key_id in: path description: The key ID matching the project deploy key. required: true schema: type: string - 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: - Get description: This API operation retrieves detailed information about a specific deploy key that has been added to a project within a Bitbucket workspace. By providing the workspace identifier, project key, and the unique key ID, you can fetch the deploy key's properties including its public SSH key content, label, creation date, and associated permissions. Deploy keys are SSH keys that grant read-only or read-write access to repositories within a project, commonly used for automated deployments and CI/CD pipelines to securely access repository code without requiring user credentials. summary: Atlassian Get a Project Deploy Key responses: '200': description: Project deploy key matching the key ID content: application/json: schema: $ref: '#/components/schemas/project_deploy_key' examples: project-deploy-key_2: $ref: '#/components/examples/project-deploy-key_2' '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: atlassianGetAProjectDeployKey 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/{group_slug}: parameters: - name: group_slug in: path description: Slug of the requested group. required: true schema: type: string - 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: - Get description: This API operation retrieves the explicit permission settings assigned to a specific group for a particular project within a Bitbucket workspace. By providing the workspace identifier, project key, and group slug as path parameters, the endpoint returns detailed information about what access level and permissions have been directly granted to that group for the specified project. This is useful for auditing group-level permissions, understanding access control configurations, and managing team-based security policies within Bitbucket projects, as it shows only the permissions explicitly set for the group rather than inherited or default permissions. summary: Atlassian Get an Explicit Group Permission for a Project responses: '200': description: Project group permission content: application/json: schema: $ref: '#/components/schemas/project_group_permission' examples: project-group-permission: $ref: '#/components/examples/project-group-permission' '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 more of the workspace, project, and group doesn'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: atlassianGetAnExplicitGroupPermissionForAProject x-api-evangelist-processing: WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/analytics/content/{contentId}/views: get: tags: - Get summary: Atlassian Get Views description: This API endpoint retrieves view analytics for a specific piece of Confluence content by its content ID. It returns data about how many times the content has been viewed, providing insights into content engagement and popularity. The endpoint uses a GET request to fetch view statistics for pages, blog posts, or other content types within a Confluence space, allowing administrators and content owners to track and analyze content consumption patterns. operationId: getViews parameters: - name: contentId in: path description: The ID of the content to get the views for. required: true schema: type: string - name: fromDate in: query description: The number of views for the content since the date. schema: type: string example: '2021-03-21T00:00:00.000Z' responses: '200': description: Returns the total number of views for the content. content: application/json: schema: type: object properties: id: type: integer description: The content ID. count: type: integer description: The total number of views for the content. examples: undefined: $ref: '#/components/examples/undefined_3' '400': description: Returned if client input is invalid. '401': description: Returned if the authentication credentials are incorrect. content: {} '403': description: 'Returned if the authentication credentials are missing from the request.' content: {} '404': description: 'Returned if; - There is no content with the given ID.' security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:analytics.content:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/analytics/content/{contentId}/viewers: get: tags: - Get summary: Atlassian Get Viewers description: This API endpoint retrieves analytics data about viewers for a specific piece of Confluence content identified by its contentId. When called with a GET request, it returns information about users who have viewed the specified content, which can be useful for understanding content engagement and reach within your Confluence space. The endpoint is part of the Confluence Analytics REST API and requires appropriate authentication and permissions to access viewer statistics for the requested content. operationId: getViewers parameters: - name: contentId in: path description: The ID of the content to get the viewers for. required: true schema: type: string - name: fromDate in: query description: The number of views for the content since the date. schema: type: string example: '2021-03-21T00:00:00.000Z' responses: '200': description: Returns the total number of distinct viewers for the content. content: application/json: schema: type: object properties: id: type: integer description: The content ID. count: type: integer description: The total number of distinct viewers for the content. examples: undefined_2: $ref: '#/components/examples/undefined_2' '400': description: Returned if client input is invalid. '401': description: Returned if the authentication credentials are incorrect. content: {} '403': description: 'Returned if the authentication credentials are missing from the request.' content: {} '404': description: 'Returned if; - There is no content with the given ID.' security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:analytics.content:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/audit/retention: get: tags: - Get summary: Atlassian Get Retention Period description: The Get Retention Period operation retrieves the current retention period configured for audit records in Atlassian Confluence. This API endpoint returns information about how long audit log entries are stored before being automatically deleted from the system. The retention period is an important compliance and storage management setting that determines the lifespan of audit trail data, which includes user actions, system events, and administrative changes within the Confluence instance. This read-only operation is typically used by administrators to verify current audit retention policies and ensure they align with organizational compliance requirements and data governance standards. operationId: getRetentionPeriod responses: '200': description: Returned if the requested retention period is returned. content: application/json: schema: $ref: '#/components/schemas/RetentionPeriod' examples: undefined: $ref: '#/components/examples/undefined_4' '403': description: 'Returned if the calling user does not have permission to view the audit log.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:audit-log:confluence x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:audit-log:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-connect-scope: INACCESSIBLE x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/audit/since: get: tags: - Get summary: Atlassian Get Audit Records for Time Period description: The Atlassian Confluence Audit API endpoint `/wiki/rest/api/audit/since` using the GET method retrieves audit records that have been created since a specified time period. This operation allows administrators and authorized users to query and review system audit logs within a defined timeframe, providing visibility into user actions, system changes, and security-related events that occurred after a particular timestamp. The endpoint is essential for compliance monitoring, security auditing, and tracking changes made to Confluence spaces, pages, and configuration settings over time. operationId: getAuditRecordsForTimePeriod parameters: - name: number in: query description: The number of units for the time period. schema: type: integer format: int64 default: 3 - name: units in: query description: The unit of time that the time period is measured in. schema: type: string default: MONTHS enum: - NANOS - MICROS - MILLIS - SECONDS - MINUTES - HOURS - HALF_DAYS - DAYS - WEEKS - MONTHS - YEARS - DECADES - CENTURIES - name: searchString in: query description: 'Filters the results to records that have string property values matching the `searchString`.' schema: type: string - name: start in: query description: The starting index of the returned records. schema: minimum: 0 type: integer format: int32 default: 0 - name: limit in: query description: 'The maximum number of records to return per page. Note, this may be restricted by fixed system limits.' schema: minimum: 0 type: integer format: int32 default: 1000 responses: '200': description: Returned if the requested records are returned. content: application/json: schema: $ref: '#/components/schemas/AuditRecordArray' examples: undefined_2: $ref: '#/components/examples/undefined_2_2' '403': description: 'Returned if the calling user does not have permission to view the audit log.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:audit-log:confluence x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:audit-log:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-connect-scope: INACCESSIBLE x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true GenerateExampleFromOperationResponseSchema: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /atlassian-connect/1/app/module/dynamic: get: tags: - Get summary: Atlassian Get Modules description: The Get Modules API operation retrieves information about dynamically registered modules within an Atlassian Connect app. This endpoint allows developers to query and fetch details about modules that have been registered dynamically rather than statically defined in the app descriptor. By making a GET request to this endpoint, you can obtain a list of all dynamic modules currently registered for your Connect app, including their configurations, types, and metadata. This is particularly useful for managing and auditing modules that are added or modified at runtime, enabling developers to programmatically verify which modules are active and accessible within the Atlassian product integration. operationId: getModules responses: '200': description: Returned if the request is successful. content: '*/*': schema: $ref: '#/components/schemas/ConnectModules' '401': description: Returned if the call is not from a Connect app. content: '*/*': schema: $ref: '#/components/schemas/DynamicModulesErrorMessage' message: example: The request is not from a Connect app. deprecated: false x-experimental: true x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-connect-scope: INACCESSIBLE security: - bearerHttpAuthentication: [] x-api-evangelist-processing: AddBearerAuthtoOperations: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}: get: tags: - Get summary: Atlassian Get Content by Id deprecated: true description: The Get Content By Id operation retrieves a single piece of content from Atlassian Confluence using its unique identifier. This REST API endpoint accepts the content ID as a path parameter and returns detailed information about the specified content, including its type (page, blog post, comment, etc.), title, body, version information, space details, metadata, and associated properties. The response can be customized using query parameters to expand specific fields, limit the body representation format, or filter the returned data. This operation requires appropriate read permissions for the content being accessed and is commonly used to fetch complete content details for display, editing, or integration purposes in both native Confluence applications and third-party tools that need to programmatically access wiki content. operationId: getContentById parameters: - name: id in: path description: 'The ID of the content to be returned. If you don''t know the content ID, use [Get content](#api-content-get) and filter the results.' required: true schema: type: string - name: status in: query description: 'Filter the results to a set of content based on their status. If set to `any`, content with any status is returned. Note, the `historical` status is currently not supported.' style: form explode: true schema: type: array items: type: string default: - current enum: - current - trashed - deleted - historical - draft - any - name: version in: query description: The version number of the content to be returned. schema: type: integer format: int32 - name: embeddedContentRender in: query description: 'The version of embedded content (e.g. attachments) to render. - current renders the latest version of the embedded content. - version-at-save renders the version of the embedded content at the time of save.' schema: type: string default: current enum: - current - version-at-save - $ref: '#/components/parameters/contentExpandWithSubExpandLimit' - name: trigger in: query description: 'If set to `viewed`, the request will trigger a ''viewed'' event for the content. When this event is triggered, the page/blogpost will appear on the ''Recently visited'' tab of the user''s Confluence dashboard.' schema: type: string enum: - viewed responses: '200': description: Returned if the requested content is returned. content: application/json: schema: $ref: '#/components/schemas/Content' '400': description: 'Returned if; - The content id is invalid. - The sub-expansions limit exceeds.' content: {} '401': description: Returned if the authentication credentials are incorrect or missing from the request. content: {} '403': description: Returned if the calling user can not view the content. content: {} '404': description: 'Returned if; - There is no content with the given ID. - The requesting user does not have permission to view the content.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/child: get: tags: - Get summary: Atlassian Get Content Children deprecated: true description: This API operation retrieves the direct children of a specified Confluence content item by its ID. When called with a GET request to the endpoint, it returns a paginated list of child pages, comments, or attachments depending on the parent content type. The operation supports query parameters to filter results by child content type, expand additional properties, set pagination limits, and sort the returned children. This is commonly used to navigate the content hierarchy in Confluence, such as retrieving all sub-pages under a parent page or fetching comments associated with a blog post. operationId: getContentChildren parameters: - name: id in: path description: The ID of the content to be queried for its children. required: true schema: type: string - name: expand in: query description: 'A multi-value parameter indicating which properties of the children to expand, where: - `attachment` returns all attachments for the content. - `comments` returns all comments for the content. - `page` returns all child pages of the content. - Custom content types that are provided by apps are also supported.' style: form explode: false schema: type: array items: type: string - name: parentVersion in: query description: 'The version of the parent content to retrieve children for. Currently, this only works for the latest version.' schema: type: integer format: int32 default: 0 responses: '200': description: Returned if the requested content children are returned. content: application/json: schema: $ref: '#/components/schemas/ContentChildren' '404': description: 'Returned if; - There is no content with the given ID. - The calling user does not have permission to view the content.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/child/attachment: get: tags: - Get summary: Atlassian Get Attachments deprecated: true description: This operation retrieves all attachments that are children of a specific Confluence content page identified by its ID. It returns a paginated list of attachment objects associated with the given content, where each attachment contains metadata such as filename, media type, file size, download URL, and version information. The response can be filtered and expanded using optional query parameters to include additional details like attachment history, version information, or container details. This endpoint is useful for discovering what files are attached to a particular Confluence page and accessing their properties without having to download the actual file content. operationId: getAttachments parameters: - name: id in: path description: The ID of the content to be queried for its attachments. required: true schema: type: string - $ref: '#/components/parameters/contentExpand' - name: start in: query description: The starting index of the returned attachments. schema: minimum: 0 type: integer format: int32 default: 0 - name: limit in: query description: 'The maximum number of attachments to return per page. Note, this may be restricted by fixed system limits.' schema: minimum: 0 type: integer format: int32 default: 25 - name: filename in: query description: Filter the results to attachments that match the filename. schema: type: string - name: mediaType in: query description: Filter the results to attachments that match the media type. schema: type: string responses: '200': description: Returned if the requested attachments are returned. content: application/json: schema: $ref: '#/components/schemas/ContentArray' '404': description: 'Returned if; - There is no parent content with the given ID. - The calling user does not have permission to view the parent content.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/child/attachment/{attachmentId}/download: get: tags: - Get summary: Atlassian Get Uri to Download Attachment description: This API operation retrieves the download URI for a specific attachment in Atlassian Confluence. By providing both the parent content ID and the attachment ID in the endpoint path, the operation returns the direct download link that can be used to fetch the actual attachment file. This is particularly useful when you need to programmatically access or download files that have been attached to Confluence pages or blog posts, allowing applications to retrieve documents, images, or other file types stored within Confluence content without manually navigating through the web interface. operationId: getUriToDownloadAttachment parameters: - name: id in: path description: The ID of the content that the attachment is attached to. required: true schema: type: string - name: attachmentId in: path description: The ID of the attachment to download. required: true schema: type: string - name: version in: query description: The version of the attachment. If this parameter is absent, the redirect URI will download the latest version of the attachment. schema: type: integer responses: '302': description: Returned if download URL is found. '400': description: Returned if version number is greater than attachment's latest version number or an invalid value. '401': description: Returned if there are authentication issues in request. '404': description: 'Returned if; - No content is found with the specified content ID. - The specified content does not contain an attachment with the specified attachment ID. - The calling user does not have permission to view the attachment.' security: - basicAuth: [] - oAuthDefinitions: - readonly:content.attachment:confluence x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - readonly:content.attachment:confluence - scheme: oAuthDefinitions state: Beta scopes: - read:attachment:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/child/comment: get: tags: - Get summary: Atlassian Get Content Comments deprecated: true description: This API operation retrieves all comments that are children of a specific piece of content in Atlassian Confluence. By making a GET request to the endpoint with a content ID, you can fetch a paginated list of comments associated with that content, which may include inline comments, page comments, or footer comments. The response typically includes comment metadata such as the comment body, author information, creation date, modification history, and version details. This endpoint is useful for applications that need to display, analyze, or process user feedback and discussions related to Confluence pages, blog posts, or other content types. Optional query parameters can be used to expand specific fields, limit the number of results, or control pagination through the comment collection. operationId: getContentComments parameters: - name: id in: path description: The ID of the content to be queried for its comments. required: true schema: type: string - $ref: '#/components/parameters/contentExpand' - name: parentVersion in: query description: 'The version of the parent content to retrieve children for. Currently, this only works for the latest version.' schema: minimum: 0 type: integer format: int32 default: 0 - name: start in: query description: The starting index of the returned comments. schema: type: integer format: int32 - name: limit in: query description: 'The maximum number of comments to return per page. Note, this may be restricted by fixed system limits.' schema: minimum: 0 type: integer format: int32 default: 25 - name: location in: query description: 'The location of the comments in the page. Multiple locations can be specified. If no location is specified, comments from all locations are returned.' style: form explode: true schema: type: array items: type: string enum: - inline - footer - resolved - name: depth in: query description: 'Currently, this parameter is not used. Comments are returned at the root level only.' schema: type: string responses: '200': description: Returned if the requested comments are returned. content: application/json: schema: $ref: '#/components/schemas/ContentArray' '404': description: 'Returned if; - There is no parent content with the given ID. - The calling user does not have permission to view the parent content.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/child/{type}: get: tags: - Get summary: Atlassian Get Content Children by Type deprecated: true description: This API operation retrieves child content of a specific type for a given Confluence page or content item. By specifying the parent content ID and the desired child type (such as page, comment, or attachment) in the URL path, the endpoint returns a paginated list of all child elements matching that type. This is useful for navigating content hierarchies, accessing page comments, retrieving attachments, or discovering child pages within a Confluence space structure. The response includes metadata about each child item along with pagination parameters for handling large result sets. operationId: getContentChildrenByType parameters: - name: id in: path description: The ID of the content to be queried for its children. required: true schema: type: string - name: type in: path description: The type of children to return. required: true schema: type: string - $ref: '#/components/parameters/contentExpand' - name: parentVersion in: query description: 'The version of the parent content to retrieve children for. Currently, this only works for the latest version.' schema: minimum: 0 type: integer format: int32 default: 0 - name: start in: query description: The starting index of the returned content. schema: type: integer format: int32 - name: limit in: query description: 'The maximum number of content to return per page. Note, this may be restricted by fixed system limits.' schema: minimum: 0 type: integer format: int32 default: 25 responses: '200': description: Returned if the requested content is returned. content: application/json: schema: $ref: '#/components/schemas/ContentArray' '400': description: 'Returned if the parent type and desired child content type are not compatible. Eg: Cannot find `page` children of a `blogpost`.' content: {} '404': description: 'Returned if: - There is no content with the given ID. - The calling user does not have permission to view the content.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/descendant: get: tags: - Get summary: Atlassian Get Content Descendants description: This API operation retrieves all descendants of a specified Confluence content item by its ID. Descendants include all child pages, nested subpages, comments, and attachments that exist below the specified content in the content hierarchy tree. The endpoint returns a paginated list of content objects that are hierarchically related to the parent content, allowing developers to traverse and map the complete content structure beneath a given page or blog post. This is particularly useful for operations that need to work with entire content trees, such as exporting documentation sections, analyzing content relationships, or performing bulk operations on related pages. operationId: getContentDescendants parameters: - name: id in: path description: The ID of the content to be queried for its descendants. required: true schema: type: string - name: expand in: query description: 'A multi-value parameter indicating which properties of the children to expand, where: - `attachment` returns all attachments for the content. - `comments` returns all comments for the content. - `page` returns all child pages of the content.' style: form explode: false schema: type: array items: type: string enum: - attachment - comment - page responses: '200': description: Returned if the requested descendants are returned. content: application/json: schema: $ref: '#/components/schemas/ContentChildren' '404': description: 'Returned if; - There is no content with the given ID. - The calling user does not have permission to view the content.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/history: get: tags: - Get summary: Atlassian Get Content History deprecated: true description: This operation retrieves the version history and other historical metadata for a specific piece of Confluence content identified by its unique ID. When called, it returns information about who created and last modified the content, timestamps for these actions, version numbers, and potentially contributor details. This is useful for tracking changes, auditing content modifications, understanding content evolution over time, and displaying version information to users. The endpoint follows RESTful conventions and requires appropriate authentication and permissions to access the content's historical data. operationId: getContentHistory parameters: - name: id in: path description: The ID of the content to be queried for its history. required: true schema: type: string - name: expand in: query description: 'A multi-value parameter indicating which properties of the content history to expand. Maximum sub-expansions allowed is `8`. - `lastUpdated` returns information about the most recent update of the content, including who updated it and when it was updated. - `previousVersion` returns information about the update prior to the current content update. For this method, it contains the same information as `lastUpdated`. - `contributors` returns all of the users who have contributed to the content. - `nextVersion` This parameter is not used for this method.' style: form explode: false schema: type: array items: type: string enum: - lastUpdated - previousVersion - contributors - nextVersion responses: '200': description: Returned if the requested content history is returned. content: application/json: schema: $ref: '#/components/schemas/ContentHistory' '400': description: Returned if sub-expansions limit exceeds. content: {} '401': description: 'Returned if the authentication credentials are incorrect or missing from the request.' content: {} '404': description: 'Returned if; - There is no content with the given ID. - The calling user does not have permission to view the content.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:content.metadata:confluence - read:user:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}: get: tags: - Get summary: Atlassian Get Macro Body by Macro Id description: 'Retrieves the body content of a specific macro identified by its macro ID within a particular version of a Confluence page. This endpoint requires three path parameters: the content ID of the page, the version number of that content, and the unique macro ID whose body you want to retrieve. It''s particularly useful when you need to extract or inspect the content of a specific macro instance that existed in a historical version of a page, allowing developers to access macro parameters, content, or configuration from past revisions without having to parse the entire page markup.' operationId: getMacroBodyByMacroId parameters: - name: id in: path description: The ID for the content that contains the macro. required: true schema: type: string - name: version in: path description: 'The version of the content that contains the macro. Specifying `0` as the `version` will return the macro body for the latest content version.' required: true schema: type: integer format: int32 - name: macroId in: path description: 'The ID of the macro. This is usually passed by the app that the macro is in. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, ''/content/196611/version/7?expand=content.body.storage''.' required: true schema: type: string responses: '200': description: Returned if the requested macro body is returned. content: application/json: schema: $ref: '#/components/schemas/MacroInstance' '401': description: 'Returned if the authentication credentials are incorrect or missing from the request.' content: {} '404': description: 'Returned if; - There is no content with the given ID. - The calling user does not have permission to view the content. - The macro does not exist in the specified version. - There is no macro matching the given macro ID or hash.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.all x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.all - scheme: oAuthDefinitions state: Beta scopes: - read:content.metadata:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/{to}: get: tags: - Get summary: Atlassian Get Macro Body by Macro Id and Convert the Representation Synchronously description: This API operation retrieves the body content of a specific macro from a particular version of a Confluence page and converts it to a desired representation format synchronously. By providing the content ID, version number, macro ID, and target format in the endpoint path, users can fetch macro content and have it transformed on-the-fly into formats such as view, export_view, styled_view, storage, editor, or anonymous_export_view. This is particularly useful when you need to extract and transform macro content from historical versions of pages without having to manually parse and convert the content, enabling seamless integration with external systems or programmatic content manipulation workflows. operationId: getMacroBodyByMacroIdAndConvertTheRepresentationSynchronously parameters: - name: id in: path description: The ID for the content that contains the macro. required: true schema: type: string - name: version in: path description: 'The version of the content that contains the macro. Specifying `0` as the `version` will return the macro body for the latest content version.' required: true schema: type: integer format: int32 - name: macroId in: path description: 'The ID of the macro. This is usually passed by the app that the macro is in. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, ''/content/196611/version/7?expand=content.body.storage''.' required: true schema: type: string - name: to in: path required: true description: The content representation to return the macro in. schema: type: string - $ref: '#/components/parameters/bodyConversionExpand' - name: spaceKeyContext in: query description: 'The space key used for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link `` and the `spaceKeyContext=TEST` parameter is provided, then the link will be converted to a link to the "Example page" page in the "TEST" space.' schema: type: string - name: embeddedContentRender in: query description: 'Mode used for rendering embedded content, like attachments. - `current` renders the embedded content using the latest version. - `version-at-save` renders the embedded content using the version at the time of save.' schema: type: string default: current enum: - current - version-at-save responses: '200': description: Returned if the requested content body is returned. content: application/json: schema: $ref: '#/components/schemas/ContentBody' '400': description: Returned if invalid content representation is requested, or context is missing. '401': description: 'Returned if the authentication credentials are incorrect or missing from the request.' content: {} '404': description: 'Returned if; - There is no content with the given ID. - The calling user does not have permission to view the content. - The macro does not exist in the specified version. - There is no macro matching the given macro ID or hash.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.all x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.all - scheme: oAuthDefinitions state: Beta scopes: - read:content.metadata:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/async/{to}: get: tags: - Get summary: Atlassian Get Macro Body by Macro Id and Convert Representation Asynchronously description: This API operation retrieves the body content of a specific macro embedded within a particular version of a Confluence page and asynchronously converts it to a different representation format. By providing the content ID, version number, macro ID, and target format, the endpoint initiates a conversion process that runs in the background, allowing you to transform macro content between different supported representations (such as storage, view, or export formats) without blocking the request. This is particularly useful for handling large or complex macro content where synchronous conversion might timeout, and the asynchronous nature enables better performance and scalability when processing multiple conversion requests or dealing with resource-intensive transformations. operationId: getMacroBodyByMacroIdAndConvertRepresentationAsynchronously parameters: - name: id in: path description: The ID for the content that contains the macro. required: true schema: type: string - name: version in: path description: 'The version of the content that contains the macro. Specifying `0` as the `version` will return the macro body for the latest content version.' required: true schema: type: integer format: int32 - name: macroId in: path description: 'The ID of the macro. For apps, this is passed to the macro by the Connect/Forge framework. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, ''/content/196611/version/7?expand=content.body.storage''.' required: true schema: type: string - name: to in: path required: true description: 'The content representation to return the macro in. Currently, the following conversions are allowed: - `export_view` - `styled_view` - `view`' schema: type: string enum: - export_view - view - styled_view - $ref: '#/components/parameters/bodyConversionExpand' - name: allowCache in: query description: "If this field is false, the cache will erase its current value and begin a conversion.\nIf this field is true, the cache will not erase its current value, and will set the status of the\nresult in cache to RERUNNING. Once the data is updated, the status will change to COMPLETED. \nLarge macros that take long to convert, and who want to show intermediate, but potentially stale data, immediately should set this field to true.\nCache values are stored per macro per user per content and expansions." schema: type: boolean default: false - name: spaceKeyContext in: query description: 'The space key used for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link `` and the `spaceKeyContext=TEST` parameter is provided, then the link will be converted to a link to the "Example page" page in the "TEST" space.' schema: type: string - name: embeddedContentRender in: query description: 'Mode used for rendering embedded content, like attachments. - `current` renders the embedded content using the latest version. - `version-at-save` renders the embedded content using the version at the time of save.' schema: type: string default: current enum: - current - version-at-save responses: '200': description: Returned if the requested macro conversion request is created. content: application/json: schema: $ref: '#/components/schemas/AsyncId' '401': description: 'Returned if the authentication credentials are incorrect or missing from the request.' content: {} '404': description: 'Returned if; - There is no content with the given ID. - The calling user does not have permission to view the content. - The macro does not exist in the specified version. - There is no macro matching the given macro ID or hash.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.all x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.all - scheme: oAuthDefinitions state: Beta scopes: - read:content.metadata:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/label: get: tags: - Get summary: Atlassian Get Labels for Content deprecated: true description: This API operation retrieves all labels that have been applied to a specific piece of Confluence content identified by its unique ID. When you make a GET request to this endpoint, it returns a collection of labels associated with the specified content, which can include both user-created labels and system-generated ones. Labels in Confluence are used for categorization, organization, and searchability of content such as pages, blog posts, and attachments. The response typically includes details about each label such as its name, prefix (if applicable), and ID, allowing developers to programmatically access and manage the tagging metadata of content within a Confluence space. operationId: getLabelsForContent parameters: - name: id in: path description: The ID of the content to be queried for its labels. required: true schema: type: string - name: prefix in: query description: 'Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any prefix will be returned. - `global` prefix is used by default when a user adds a label via the UI. - `my` prefix can be explicitly added by a user when adding a label via the UI, e.g. ''my:example-label''. Also, when a page is selected as a favourite, the ''my:favourite'' label is automatically added. - `team` can used when adding labels via [Add labels to content](#api-content-id-label-post) but is not used in the UI.' schema: type: string enum: - global - my - team - name: start in: query description: The starting index of the returned labels. schema: minimum: 0 type: integer format: int32 default: 0 - name: limit in: query description: 'The maximum number of labels to return per page. Note, this may be restricted by fixed system limits.' schema: minimum: 0 type: integer format: int32 default: 200 responses: '200': description: Returned if the requested labels are returned. content: application/json: schema: $ref: '#/components/schemas/LabelArray' '403': description: Returned if the calling user can view but not edit the content. content: {} '404': description: 'Returned if; - There is no content with the given ID. - The calling user does not have permission to view the content.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:label:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/notification/child-created: get: tags: - Get summary: Atlassian Get Watches for Page description: This API operation retrieves a list of all users and groups watching a specific Confluence page for child page creation events. When called with a page ID, it returns the watches configured to notify watchers whenever a new child page is created under the specified parent page. The endpoint requires appropriate authentication and permissions to view the watch list, and it provides information about who will be notified when child content is added beneath the given page in the content hierarchy. operationId: getWatchesForPage parameters: - name: id in: path description: The ID of the content to be queried for its watches. required: true schema: type: string - name: start in: query description: The starting index of the returned watches. schema: minimum: 0 type: integer format: int32 default: 0 - name: limit in: query description: 'The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.' schema: minimum: 0 type: integer format: int32 default: 200 responses: '200': description: Returned if the requested watches are returned. content: application/json: schema: $ref: '#/components/schemas/WatchArray' '401': description: 'Returned if the authentication credentials are incorrect or missing from the request.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:watcher:confluence - read:user:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/notification/created: get: tags: - Get summary: Atlassian Get Watches for Space description: This API operation retrieves a list of all watches that have been set up for content creation events within a specific Confluence space. When called, it returns information about users who are watching for new content being created in the space identified by the provided ID parameter. The endpoint uses a GET request and is part of Atlassian Confluence's notification system, allowing administrators and developers to query which users have subscribed to receive notifications when new pages, blog posts, or other content types are added to the specified space. This is useful for understanding notification distribution, managing watch lists, or auditing user engagement with space content. operationId: getWatchesForSpace parameters: - name: id in: path description: The ID of the content to be queried for its watches. required: true schema: type: string - name: start in: query description: The starting index of the returned watches. schema: minimum: 0 type: integer format: int32 default: 0 - name: limit in: query description: 'The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.' schema: minimum: 0 type: integer format: int32 default: 200 responses: '200': description: Returned if the requested watches are returned. content: application/json: schema: $ref: '#/components/schemas/SpaceWatchArray' '401': description: 'Returned if the authentication credentials are incorrect or missing from the request.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:watcher:confluence - read:user:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/property: get: tags: - Get summary: Atlassian Get Content Properties deprecated: true description: This API operation retrieves all properties associated with a specific Confluence content item identified by its unique ID. Properties are custom key-value pairs that can be attached to content for storing additional metadata or application-specific information. The endpoint returns a paginated list of property objects, each containing the property key, value, and version information. This is useful for applications that need to read custom data attached to pages, blog posts, or other Confluence content without modifying the content itself. Authentication is required to access this endpoint, and the user must have permission to view the specified content item. operationId: getContentProperties parameters: - name: id in: path description: The ID of the content to be queried for its properties. required: true schema: type: string - name: key in: query description: The key of the content property. explode: true schema: type: array items: type: string - name: expand in: query description: 'A multi-value parameter indicating which properties of the content to expand. By default, the `version` object is expanded. - `content` returns the content that the property is stored against. - `version` returns information about the version of the property, such as the version number, when it was created, etc.' style: form explode: false schema: type: array items: type: string enum: - content - version - name: start in: query description: The starting index of the returned properties. schema: minimum: 0 type: integer format: int32 default: 0 - name: limit in: query description: 'The maximum number of properties to return per page. Note, this may be restricted by fixed system limits.' schema: minimum: 0 type: integer format: int32 default: 10 responses: '200': description: Returned if the requested properties are returned. content: application/json: schema: $ref: '#/components/schemas/ContentPropertyArray' '404': description: 'Returned if; - There is no content with the given ID - The calling user does not have permission to view the content.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-props x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-props - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/property/{key}: get: tags: - Get summary: Atlassian Get Content Property deprecated: true description: Returns a specific property from the content identified by the content ID and property key. Content properties are custom key-value pairs that can be attached to Confluence content to store additional metadata or application-specific information. This endpoint retrieves the value and details of a single property rather than listing all properties associated with the content. The property must exist on the specified content item, and the user must have permission to view the content to access its properties. The response includes the property key, value, and version information that can be useful for tracking changes or implementing optimistic locking when updating properties. operationId: getContentProperty parameters: - name: id in: path description: The ID of the content to be queried for the property. required: true schema: type: string - name: key in: path description: The key of the content property. required: true schema: type: string - name: expand in: query description: 'A multi-value parameter indicating which properties of the content to expand. By default, the `version` object is expanded. - `content` returns the content that the property is stored against. - `version` returns information about the version of the property, such as the version number, when it was created, etc.' style: form explode: false schema: type: array items: type: string enum: - content - version - name: status in: query description: 'Filter the results to a set of content based on their status. If set to `any`, content with any status is returned. By default it will fetch current and archived statuses `?status=current&status=archived`. All supported statuses - any - archived - current - deleted - draft - trashed' style: form explode: true schema: type: array items: type: string default: - current - archived enum: - any - archived - current - deleted - draft - trashed responses: '200': description: Returned if the content property is returned. content: application/json: schema: $ref: '#/components/schemas/ContentProperty' '404': description: 'Returned if; - The calling user does not have permission to view the content. - There is no content with the given ID. - There is no property with the given key.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-props x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-props - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/restriction: get: tags: - Get summary: Atlassian Get Restrictions description: This API operation retrieves the restrictions applied to a specific piece of Confluence content identified by its ID. When called, it returns information about who can view or edit the content, including any user or group-based access controls that have been configured. The restrictions help enforce content security by limiting which users or groups have permission to interact with pages, blog posts, or other content types within a Confluence space. The response typically includes details about read and update restrictions, along with the users and groups that are explicitly granted or denied access to the specified content item. operationId: getRestrictions parameters: - name: id in: path description: The ID of the content to be queried for its restrictions. required: true schema: type: string - name: expand in: query description: 'A multi-value parameter indicating which properties of the content restrictions to expand. By default, the following objects are expanded: `restrictions.user`, `restrictions.group`. - `restrictions.user` returns the piece of content that the restrictions are applied to. - `restrictions.group` returns the piece of content that the restrictions are applied to. - `content` returns the piece of content that the restrictions are applied to.' style: form explode: false schema: type: array items: type: string enum: - restrictions.user - read.restrictions.user - update.restrictions.user - restrictions.group - read.restrictions.group - update.restrictions.group - content - name: start in: query description: The starting index of the users and groups in the returned restrictions. schema: minimum: 0 type: integer format: int32 default: 0 - name: limit in: query description: 'The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits.' schema: minimum: 0 type: integer format: int32 default: 100 responses: '200': description: Returned if the requested restrictions are returned. content: application/json: schema: $ref: '#/components/schemas/ContentRestrictionArray' '404': description: 'Returned if; - There is no content with the given ID. - The calling user does not have permission to view the content.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.all x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.all - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/restriction/byOperation: get: tags: - Get summary: Atlassian Get Restrictions by Operation description: This API operation retrieves content restrictions for a specific Confluence page or blog post, organized by operation type (such as read or update). By providing the content ID in the path parameter, you can fetch all restriction details that determine which users or groups have permission to perform specific operations on that content. The response returns restrictions grouped by operation, making it easy to understand the access control rules applied to the content and identify who can view, edit, or otherwise interact with the specified page or blog post. operationId: getRestrictionsByOperation parameters: - name: id in: path description: The ID of the content to be queried for its restrictions. required: true schema: type: string - name: expand in: query description: 'A multi-value parameter indicating which properties of the content restrictions to expand. - `restrictions.user` returns the piece of content that the restrictions are applied to. Expanded by default. - `restrictions.group` returns the piece of content that the restrictions are applied to. Expanded by default. - `content` returns the piece of content that the restrictions are applied to.' style: form explode: false schema: type: array items: type: string enum: - restrictions.user - restrictions.group - content responses: '200': description: Returned if the requested restrictions are returned. content: application/json: schema: type: object additionalProperties: properties: operationType: $ref: '#/components/schemas/ContentRestriction' _links: $ref: '#/components/schemas/GenericLinks' security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.all x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.all - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}: get: tags: - Get summary: Atlassian Get Restrictions for Operation description: This API endpoint retrieves content restrictions that have been applied to a specific Confluence page or blog post for a particular operation type. By providing the content ID and an operation key (such as 'read' or 'update'), you can fetch details about which users or groups have restricted access to perform that operation on the content. The response includes information about the restrictions in place, helping administrators and developers understand and manage access controls for Confluence content programmatically. This is particularly useful for auditing permissions, enforcing security policies, or building custom integrations that need to respect existing content restrictions within a Confluence space. operationId: getRestrictionsForOperation parameters: - name: id in: path description: The ID of the content to be queried for its restrictions. required: true schema: type: string - name: operationKey in: path description: The operation type of the restrictions to be returned. required: true schema: type: string enum: - read - update - name: expand in: query description: 'A multi-value parameter indicating which properties of the content restrictions to expand. - `restrictions.user` returns the piece of content that the restrictions are applied to. Expanded by default. - `restrictions.group` returns the piece of content that the restrictions are applied to. Expanded by default. - `content` returns the piece of content that the restrictions are applied to.' style: form explode: false schema: type: array items: type: string enum: - restrictions.user - restrictions.group - content - name: start in: query description: The starting index of the users and groups in the returned restrictions. schema: minimum: 0 type: integer format: int32 default: 0 - name: limit in: query description: 'The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits.' schema: minimum: 0 type: integer format: int32 default: 100 responses: '200': description: Returned if the requested restrictions are returned. content: application/json: schema: $ref: '#/components/schemas/ContentRestriction' security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.all x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.all - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}: get: tags: - Get summary: Atlassian Get Content Restriction Status for Group deprecated: true description: 'The Atlassian Confluence Content API endpoint `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}` using the GET method retrieves the restriction status for a specific group on a particular piece of content. This operation allows administrators and authorized users to check whether a designated group has restrictions applied for a specific operation (such as read or update) on content identified by its unique ID. The endpoint requires three path parameters: the content ID, the operation key that defines the type of action being restricted, and the group name for which to check restrictions. The response returns details about whether the specified group is restricted from performing the given operation on the content, helping manage fine-grained access control within Confluence spaces and pages.' operationId: getContentRestrictionStatusForGroup parameters: - name: id in: path description: The ID of the content that the restriction applies to. required: true schema: type: string - name: operationKey in: path description: The operation that the restriction applies to. required: true schema: type: string enum: - read - update - name: groupName in: path description: 'The name of the group to be queried for whether the content restriction applies to it.' required: true schema: type: string responses: '200': description: 'Returns true if the content restriction applies to the group. The response will not return a response body.' content: {} '400': description: 'Returned if; - Group name is missing' content: {} '404': description: 'Returned if; - There is no content with the given ID. - The calling user does not have permission to view the content. - An invalid operation or group is specified.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.all x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.all - scheme: oAuthDefinitions state: Beta scopes: - read:content.restriction:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}: get: tags: - Get summary: Atlassian Get Content Restriction Status for Group description: 'This API endpoint retrieves the restriction status for a specific group on a piece of Confluence content. It requires three path parameters: the content ID, an operation key (typically ''read'' or ''update''), and a group ID. When called, it returns information about whether the specified group has restrictions applied for the given operation on that content, helping administrators and developers understand access control configurations. This is useful for auditing permissions, validating security policies, or building custom permission management interfaces that need to check if a particular group''s access to content is restricted for specific operations.' operationId: getContentRestrictionStatusForGroup parameters: - name: id in: path description: The ID of the content that the restriction applies to. required: true schema: type: string - name: operationKey in: path description: The operation that the restriction applies to. required: true schema: type: string enum: - read - update - name: groupId in: path description: 'The id of the group to be queried for whether the content restriction applies to it.' required: true schema: type: string responses: '200': description: 'Returns true if the content restriction applies to the group. The response will not return a response body.' content: {} '403': description: 'Returned if the calling user does not have permission to view the content.' content: {} '404': description: 'Returned if - There is no content with the given ID. - An invalid operation or group is specified. - Given groupId is blank or has invalid characters' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.all x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.all - scheme: oAuthDefinitions state: Beta scopes: - read:content.restriction:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user: get: tags: - Get summary: Atlassian Get Content Restriction Status for User description: Retrieves the restriction status for a specific user on a piece of Confluence content based on a given operation key. This endpoint allows you to check whether a particular user has access to perform a specific operation (such as read, update, or delete) on content identified by its ID. The operation key parameter specifies which type of operation restriction to check, while the request targets a specific user to determine if content restrictions apply to them. This is useful for administrators and developers who need to programmatically verify user permissions and content access controls within Confluence spaces, enabling them to enforce security policies and manage content visibility at a granular level. operationId: getContentRestrictionStatusForUser parameters: - name: id in: path description: The ID of the content that the restriction applies to. required: true schema: type: string - name: operationKey in: path description: The operation that is restricted. required: true schema: type: string - $ref: '#/components/parameters/userLookupKey' - $ref: '#/components/parameters/userLookupUsername' - $ref: '#/components/parameters/userLookupAccountId' responses: '200': description: 'Return true if the content restriction applies to the user. The response body will be empty.' content: {} '404': description: 'Returned if; - There is no content with the given ID. - The calling user does not have permission to view the content. - An invalid operation or user is specified.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.all x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.all - scheme: oAuthDefinitions state: Beta scopes: - read:content.restriction:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/state: get: tags: - Get summary: Atlassian Get Content State description: This API operation retrieves the current state of a specific Confluence content item by its unique identifier. When called, it returns information about the content's workflow state, including details such as the state name, color coding, and any associated metadata that indicates where the content sits within its defined lifecycle or approval process. This is particularly useful for tracking content through editorial workflows, publication processes, or custom state management systems configured within Confluence, allowing developers and administrators to programmatically monitor and respond to content status changes. operationId: getContentState parameters: - name: id in: path description: The id of the content whose content state is of interest. required: true schema: type: string - name: status in: query description: Set status to one of [current,draft,archived]. Default value is current. schema: type: string default: current enum: - current - draft - archived responses: '200': description: Returned if permission allows viewing of content. content: application/json: schema: $ref: '#/components/schemas/ContentStateResponse' '401': description: Returned if the authentication credentials are incorrect or missing from the request. '403': description: Returned if user does not have content view permission. '404': description: Returned if the content with given id can not be found. security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/version: get: tags: - Get summary: Atlassian Get Content Versions deprecated: true description: This API operation retrieves version history information for a specific piece of Confluence content identified by its unique ID. When called, it returns a paginated list of all versions associated with the content, including details such as version numbers, creation dates, authors, and version messages. The endpoint supports query parameters to filter results, limit the number of versions returned, and navigate through pages of version history. This is particularly useful for tracking changes made to a page or blog post over time, auditing content modifications, or implementing version comparison features in applications that integrate with Confluence. operationId: getContentVersions parameters: - name: id in: path description: The ID of the content to be queried for its versions. required: true schema: type: string - name: start in: query description: The starting index of the returned versions. schema: minimum: 0 type: integer format: int32 default: 0 - name: limit in: query description: 'The maximum number of versions to return per page. Note, this may be restricted by fixed system limits.' schema: minimum: 0 type: integer format: int32 default: 200 - name: expand in: query description: 'A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is expanded. - `collaborators` returns the users that collaborated on the version. - `content` returns the content for the version.' style: form explode: false schema: type: array items: type: string responses: '200': description: Returned if the requested versions are returned. content: application/json: schema: $ref: '#/components/schemas/VersionArray' '403': description: 'Returned if the calling user does not have permission to view the content.' content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/content/{id}/version/{versionNumber}: get: tags: - Get summary: Atlassian Get Content Version deprecated: true description: Returns a specific version of a piece of content identified by its content ID and version number. This operation retrieves historical versions of Confluence content such as pages or blog posts, allowing users to view previous iterations and track changes over time. The endpoint requires both the unique content identifier and the specific version number to return the requested content version along with its metadata, body content, and version details. This is particularly useful for auditing purposes, reviewing edit history, or restoring previous versions of content. operationId: getContentVersion parameters: - name: id in: path description: The ID of the content to be queried for its version. required: true schema: type: string - name: versionNumber in: path description: The number of the version to be retrieved. required: true schema: type: integer format: int32 - name: expand in: query description: 'A multi-value parameter indicating which properties of the content to expand. By default, the `content` object is expanded. - `collaborators` returns the users that collaborated on the version. - `content` returns the content for the version.' style: form explode: false schema: type: array items: type: string responses: '200': description: Returned if the version is returned. content: application/json: schema: $ref: '#/components/schemas/Version' '403': description: 'Returned if the calling user does not have permission to view the content.' content: {} '404': description: Returned if the content or version cannot be found. content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.summary x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.summary - scheme: oAuthDefinitions state: Beta scopes: - read:content-details:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: false x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /wiki/rest/api/contentbody/convert/async/{id}: get: tags: - Get summary: Atlassian Get Asynchronously Converted Content Body From the Id or the Current Status of the Task description: This API endpoint retrieves the result of an asynchronous content body conversion operation in Atlassian Confluence using a unique task identifier. When content conversion is initiated asynchronously (such as converting between different markup formats like storage format, view format, or editor format), this GET operation allows you to check the current status of the conversion task and fetch the converted content once the operation is complete. The endpoint accepts the task ID as a path parameter and returns either the converted content body if the conversion has finished successfully, the current progress status if the task is still running, or an error message if the conversion failed. This is particularly useful for handling large or complex content conversions that may take significant time to process, allowing clients to poll for completion rather than blocking while waiting for the conversion to finish. operationId: getAsynchronouslyConvertedContentBodyFromTheIdOrTheCurrentStatusOfTheTask parameters: - name: id in: path description: The asyncId of the macro task to get the converted body. required: true schema: type: string responses: '200': description: Returned if successfully found an async conversion task associated with the id. content: application/json: schema: $ref: '#/components/schemas/AsyncContentBody' '400': description: Returned if the async id is invalid. content: {} '401': description: Returned if the request was not made by an anonymous user and user is not authenticated. content: {} '403': description: Returned if the requesting user is not the user who made the conversion request. content: {} '404': description: Returned if async macro conversion task cannot be found with the provided id. content: {} security: - basicAuth: [] - oAuthDefinitions: - read:confluence-content.all x-atlassian-oauth2-scopes: - scheme: oAuthDefinitions state: Current scopes: - read:confluence-content.all - scheme: oAuthDefinitions state: Beta scopes: - read:content.metadata:confluence x-atlassian-data-security-policy: - app-access-rule-exempt: true x-codegen-request-body-name: body x-atlassian-connect-scope: READ x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true ChooseTags: 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 UsersUserKeys: required: - userAccountIds nullable: true type: object additionalProperties: true properties: users: type: array items: $ref: '#/components/schemas/User' example: [] userKeys: type: array items: type: string example: [] _links: $ref: '#/components/schemas/GenericLinks' 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: {} Watch: required: - contentId - type - watcher type: object properties: type: type: string example: example_value watcher: $ref: '#/components/schemas/WatchUser' contentId: type: integer format: int64 example: '500123' TopNavigationLookAndFeel: required: - highlightColor type: object properties: color: type: string nullable: true example: example_value highlightColor: type: string example: example_value hoverOrFocus: type: object properties: backgroundColor: type: string color: type: string example: example_value HeaderLookAndFeel: required: - backgroundColor - button - primaryNavigation - search - secondaryNavigation type: object properties: backgroundColor: type: string example: example_value button: $ref: '#/components/schemas/ButtonLookAndFeel' primaryNavigation: $ref: '#/components/schemas/NavigationLookAndFeel' secondaryNavigation: $ref: '#/components/schemas/NavigationLookAndFeel' search: $ref: '#/components/schemas/SearchFieldLookAndFeel' 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 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 branching_model: allOf: - $ref: '#/components/schemas/object' - type: object title: Branching Model description: A repository's branching model properties: branch_types: type: array description: The active branch types. items: type: object properties: kind: type: string description: The kind of branch. enum: - feature - bugfix - release - hotfix prefix: type: string description: The prefix for this branch type. A branch with this prefix will be classified as per `kind`. The prefix must be a valid prefix for a branch and must always exist. It cannot be blank, empty or `null`. required: - kind - prefix additionalProperties: false minItems: 0 maxItems: 4 uniqueItems: true development: type: object properties: branch: $ref: '#/components/schemas/branch' name: type: string description: Name of the target branch. Will be listed here even when the target branch does not exist. Will be `null` if targeting the main branch and the repository is empty. use_mainbranch: type: boolean description: Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`). required: - name - use_mainbranch additionalProperties: false production: type: object properties: branch: $ref: '#/components/schemas/branch' name: type: string description: Name of the target branch. Will be listed here even when the target branch does not exist. Will be `null` if targeting the main branch and the repository is empty. use_mainbranch: type: boolean description: Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`). required: - name - use_mainbranch additionalProperties: false additionalProperties: true 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 SuperBatchWebResources: type: object properties: uris: type: object properties: all: oneOf: - type: array items: type: string - type: string css: oneOf: - type: array items: type: string - type: string js: oneOf: - type: array items: type: string - type: string example: example_value tags: type: object properties: all: type: string css: type: string data: type: string js: type: string example: example_value metatags: type: string example: example_value _expandable: type: object additionalProperties: true example: example_value 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 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 AuditRecordArray: required: - _links - limit - results - size - start type: object properties: results: example: example_value start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 _links: $ref: '#/components/schemas/GenericLinks' effective_repo_branching_model: allOf: - $ref: '#/components/schemas/object' - type: object title: Effective Repository Branching Model description: A repository's effective branching model properties: branch_types: type: array description: The active branch types. items: type: object properties: kind: type: string description: The kind of branch. enum: - feature - bugfix - release - hotfix prefix: type: string description: The prefix for this branch type. A branch with this prefix will be classified as per `kind`. The prefix must be a valid prefix for a branch and must always exist. It cannot be blank, empty or `null`. required: - kind - prefix additionalProperties: false minItems: 0 maxItems: 4 uniqueItems: true development: type: object properties: branch: $ref: '#/components/schemas/branch' name: type: string description: Name of the target branch. Will be listed here even when the target branch does not exist. Will be `null` if targeting the main branch and the repository is empty. use_mainbranch: type: boolean description: Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`). required: - name - use_mainbranch additionalProperties: false production: type: object properties: branch: $ref: '#/components/schemas/branch' name: type: string description: Name of the target branch. Will be listed here even when the target branch does not exist. Will be `null` if targeting the main branch and the repository is empty. use_mainbranch: type: boolean description: Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`). required: - name - use_mainbranch additionalProperties: false additionalProperties: true ContentState: required: - id - name - color type: object properties: id: type: integer description: identifier of content state. If 0, 1, or 2, this is a default space state format: int64 example: abc123 name: type: string description: name of content state. example: Example Title color: type: string description: hex string representing color of state example: example_value snippet_commit: allOf: - $ref: '#/components/schemas/base_commit' - 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 SpaceDescription: required: - embeddedContent - representation - value type: object additionalProperties: true properties: value: type: string example: example_value representation: type: string enum: - plain - view example: plain embeddedContent: type: array items: type: object properties: {} example: [] GenericUserKey: type: string nullable: true description: 'This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' ContentMetadata: type: object additionalProperties: true properties: currentuser: type: object properties: favourited: type: object properties: isFavourite: type: boolean favouritedDate: type: string format: date-time lastmodified: type: object properties: version: $ref: '#/components/schemas/Version' friendlyLastModified: type: string lastcontributed: type: object properties: status: type: string when: type: string format: date-time viewed: type: object properties: lastSeen: type: string format: date-time friendlyLastSeen: type: string scheduled: type: object _expandable: type: object properties: favourited: type: string lastmodified: type: string lastcontributed: type: string viewed: type: string scheduled: type: string example: example_value properties: $ref: '#/components/schemas/GenericLinks' frontend: type: object additionalProperties: true example: example_value labels: oneOf: - $ref: '#/components/schemas/LabelArray' - type: array items: $ref: '#/components/schemas/Label' example: example_value description: Metadata object for page, blogpost, comment content 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 SpacePermission: required: - anonymousAccess - operation - unlicensedAccess type: object properties: id: type: integer format: int64 example: abc123 subjects: type: object properties: user: required: - results - size type: object properties: results: type: array items: $ref: '#/components/schemas/User' size: type: integer format: int32 start: type: integer format: int32 limit: type: integer format: int32 group: required: - results - size type: object properties: results: type: array items: $ref: '#/components/schemas/Group' size: type: integer format: int32 start: type: integer format: int32 limit: type: integer format: int32 _expandable: type: object properties: user: type: string group: type: string description: The users and/or groups that the permission applies to. example: example_value operation: $ref: '#/components/schemas/OperationCheckResult' anonymousAccess: type: boolean description: Grant anonymous users permission to use the operation. default: false example: true unlicensedAccess: type: boolean description: 'Grants access to unlicensed users from JIRA Service Desk when used with the ''read space'' operation.' default: false example: true description: "This object represents a permission for given space. Permissions consist of\nat least one operation object with an accompanying subjects object.\n\nThe following combinations of `operation` and `targetType` values are\nvalid for the `operation` object:\n\n - 'create': 'page', 'blogpost', 'comment', 'attachment'\n - 'read': 'space'\n - 'delete': 'page', 'blogpost', 'comment', 'attachment'\n - 'export': 'space'\n - 'administer': 'space'" ContentArray: required: - _links - results - size type: object properties: results: type: array items: $ref: '#/components/schemas/Content' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 _links: $ref: '#/components/schemas/GenericLinks' 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 ContentRestriction: required: - _expandable - _links - operation type: object properties: operation: type: string enum: - administer - copy - create - delete - export - move - purge - purge_version - read - restore - update - use example: administer restrictions: type: object properties: user: $ref: '#/components/schemas/UserArray' group: $ref: '#/components/schemas/GroupArray' _expandable: type: object properties: user: type: string group: type: string example: example_value content: $ref: '#/components/schemas/Content' _expandable: type: object properties: restrictions: type: string content: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' 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. 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 snippet_comment: allOf: - $ref: '#/components/schemas/object' - 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 Embeddable: type: object additionalProperties: true ContentRestrictionArray: required: - _links - limit - restrictionsHash - results - size - start type: object properties: results: type: array items: $ref: '#/components/schemas/ContentRestriction' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 restrictionsHash: type: string description: 'This property is used by the UI to figure out whether a set of restrictions has changed.' example: example_value _links: $ref: '#/components/schemas/GenericLinks' 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 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. 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 ContainerLookAndFeel: required: - background - backgroundColor - backgroundImage - backgroundSize - borderRadius - padding type: object nullable: true properties: background: type: string example: example_value backgroundAttachment: type: string nullable: true example: example_value backgroundBlendMode: type: string nullable: true example: example_value backgroundClip: type: string nullable: true example: example_value backgroundColor: type: string nullable: true example: example_value backgroundImage: type: string nullable: true example: example_value backgroundOrigin: type: string nullable: true example: example_value backgroundPosition: type: string nullable: true example: example_value backgroundRepeat: type: string nullable: true example: example_value backgroundSize: type: string nullable: true example: example_value padding: type: string example: example_value borderRadius: type: string example: example_value MenusLookAndFeel: required: - color - hoverOrFocus type: object properties: hoverOrFocus: required: - backgroundColor type: object properties: backgroundColor: type: string example: example_value color: type: string example: example_value 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 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 Icon: required: - height - isDefault - path - width type: object nullable: true properties: path: type: string example: example_value width: type: integer format: int32 example: 10 height: type: integer format: int32 example: 10 isDefault: type: boolean example: true description: This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting. GenericAccountId: type: string nullable: true description: 'The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.' 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 pipeline_ssh_key_pair: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipeline SSH Key Pair description: A Pipelines SSH key pair. properties: private_key: type: string description: The SSH private key. This value will be empty when retrieving the SSH key pair. public_key: type: string description: The SSH public key. AsyncId: required: - asyncId type: object properties: asyncId: type: string example: '500123' MacroInstance: type: object properties: name: type: string example: Example Title body: type: string example: example_value parameters: type: object example: example_value _links: $ref: '#/components/schemas/GenericLinks' ContentBody: required: - representation - value type: object properties: value: type: string example: example_value representation: type: string enum: - view - export_view - styled_view - storage - editor - editor2 - anonymous_export_view - wiki - atlas_doc_format - raw example: view embeddedContent: type: array items: $ref: '#/components/schemas/EmbeddedContent' example: [] webresource: $ref: '#/components/schemas/WebResourceDependencies' mediaToken: type: object properties: collectionIds: type: array items: type: string contentId: type: string expiryDateTime: type: string fileIds: type: array items: type: string token: type: string example: example_value _expandable: type: object properties: content: type: string embeddedContent: type: string webresource: type: string mediaToken: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' 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 branching_model_settings: allOf: - $ref: '#/components/schemas/object' - type: object title: Branching Model Settings description: A repository's branching model settings 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 branch_types: type: array items: type: object properties: enabled: type: boolean description: Whether the branch type is enabled or not. A disabled branch type may contain an invalid `prefix`. kind: type: string description: The kind of the branch type. enum: - feature - bugfix - release - hotfix prefix: type: string description: The prefix for this branch type. A branch with this prefix will be classified as per `kind`. The `prefix` of an enabled branch type must be a valid branch prefix.Additionally, it cannot be blank, empty or `null`. The `prefix` for a disabled branch type can be empty or invalid. required: - kind additionalProperties: false minItems: 0 maxItems: 4 uniqueItems: true development: type: object properties: is_valid: type: boolean description: Indicates if the configured branch is valid, that is, if the configured branch actually exists currently. Is always `true` when `use_mainbranch` is `true` (even if the main branch does not exist). This field is read-only. This field is ignored when updating/creating settings. name: type: string description: The configured branch. It must be `null` when `use_mainbranch` is `true`. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set). In this case `is_valid` will be `false`. The branch must exist when updating/setting the `name` or an error will occur. use_mainbranch: type: boolean description: Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`). When `true` the `name` must be `null` or not provided. When `false` the `name` must contain a non-empty branch name. additionalProperties: false production: type: object properties: is_valid: type: boolean description: Indicates if the configured branch is valid, that is, if the configured branch actually exists currently. Is always `true` when `use_mainbranch` is `true` (even if the main branch does not exist). This field is read-only. This field is ignored when updating/creating settings. name: type: string description: The configured branch. It must be `null` when `use_mainbranch` is `true`. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set). In this case `is_valid` will be `false`. The branch must exist when updating/setting the `name` or an error will occur. use_mainbranch: type: boolean description: Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`). When `true` the `name` must be `null` or not provided. When `false` the `name` must contain a non-empty branch name. enabled: type: boolean description: Indicates if branch is enabled or not. additionalProperties: false additionalProperties: true 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 VersionArray: required: - _links - limit - results - size - start type: object properties: results: type: array items: $ref: '#/components/schemas/Version' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 _links: $ref: '#/components/schemas/GenericLinks' Version: required: - minorEdit - number - when type: object nullable: true additionalProperties: true properties: by: $ref: '#/components/schemas/User' when: type: string format: date-time nullable: true example: '2026-01-15T10:30:00Z' friendlyWhen: type: string nullable: true example: example_value message: type: string nullable: true example: example_value number: type: integer format: int32 description: Set this to the current version number incremented by one example: 10 minorEdit: description: 'If `minorEdit` is set to ''true'', no notification email or activity stream will be generated for the change.' type: boolean example: true content: $ref: '#/components/schemas/Content' collaborators: $ref: '#/components/schemas/UsersUserKeys' _expandable: type: object properties: content: type: string collaborators: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' contentTypeModified: type: boolean description: True if content type is modifed in this version (e.g. page to blog) example: true confRev: type: string nullable: true description: The revision id provided by confluence to be used as a revision in Synchrony example: example_value syncRev: type: string nullable: true description: The revision id provided by Synchrony example: example_value syncRevSource: type: string nullable: true description: Source of the synchrony revision example: example_value 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: {} 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. 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} ContentStateResponse: type: object properties: contentState: $ref: '#/components/schemas/ContentState' description: Null or content state lastUpdated: type: string description: Timestamp of last publish event where content state changed example: example_value UserDetails: type: object properties: business: type: object properties: position: type: string description: 'This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' department: type: string description: 'This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' location: type: string description: 'This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' example: example_value personal: type: object properties: phone: type: string description: 'This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' im: type: string description: 'This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' website: type: string description: 'This property has been deprecated due to privacy changes. There is no replacement. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' email: type: string description: 'This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' example: example_value HorizontalHeaderLookAndFeel: required: - backgroundColor - primaryNavigation type: object properties: backgroundColor: type: string example: example_value button: $ref: '#/components/schemas/ButtonLookAndFeel' primaryNavigation: $ref: '#/components/schemas/TopNavigationLookAndFeel' secondaryNavigation: $ref: '#/components/schemas/NavigationLookAndFeel' search: $ref: '#/components/schemas/SearchFieldLookAndFeel' ButtonLookAndFeel: required: - backgroundColor - color type: object nullable: true properties: backgroundColor: type: string example: example_value color: type: string example: example_value SpaceSettings: nullable: true required: - _links - routeOverrideEnabled type: object properties: routeOverrideEnabled: type: boolean description: 'Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.' example: true editor: required: - page - blogpost - default type: object properties: page: type: string blogpost: type: string default: type: string example: example_value spaceKey: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' 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 WatchUser: required: - type - accountId - profilePicture - displayName - operations - isExternalCollaborator - accountType - email - publicName - personalSpace - externalCollaborator type: object properties: type: type: string example: example_value username: $ref: '#/components/schemas/GenericUserName' userKey: $ref: '#/components/schemas/GenericUserKey' accountId: $ref: '#/components/schemas/GenericAccountId' profilePicture: $ref: '#/components/schemas/Icon' displayName: type: string example: example_value timeZone: nullable: true type: string example: example_value operations: type: array nullable: true items: $ref: '#/components/schemas/OperationCheckResult' example: [] isExternalCollaborator: type: boolean example: true details: $ref: '#/components/schemas/UserDetails' accountType: type: string example: example_value email: type: string example: user@example.com publicName: type: string example: example_value personalSpace: type: object nullable: true example: example_value externalCollaborator: type: boolean example: true description: 'This essentially the same as the `User` object, but no `_links` property and no `_expandable` property (therefore, different required fields).' ContentChildType: type: object properties: attachment: required: - _links - value type: object properties: value: type: boolean _links: $ref: '#/components/schemas/GenericLinks' example: example_value comment: required: - _links - value type: object properties: value: type: boolean _links: $ref: '#/components/schemas/GenericLinks' example: example_value page: required: - _links - value type: object properties: value: type: boolean _links: $ref: '#/components/schemas/GenericLinks' example: example_value _expandable: type: object properties: all: type: string attachment: type: string comment: type: string page: type: string whiteboard: type: string example: example_value additionalProperties: true description: 'Shows whether a piece of content has attachments, comments, or child pages/whiteboards. Note, this doesn''t actually contain the child objects.' 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 ContentHistory: required: - latest type: object nullable: true properties: latest: type: boolean example: true createdBy: $ref: '#/components/schemas/User' ownedBy: $ref: '#/components/schemas/User' lastOwnedBy: $ref: '#/components/schemas/User' createdDate: type: string format: date-time example: '2026-01-15T10:30:00Z' lastUpdated: $ref: '#/components/schemas/Version' previousVersion: $ref: '#/components/schemas/Version' contributors: type: object properties: publishers: $ref: '#/components/schemas/UsersUserKeys' example: example_value nextVersion: $ref: '#/components/schemas/Version' _expandable: type: object properties: lastUpdated: type: string previousVersion: type: string contributors: type: string nextVersion: type: string ownedBy: type: string lastOwnedBy: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' pipelines_config: allOf: - $ref: '#/components/schemas/object' - additionalProperties: true type: object title: Pipelines Configuration description: The Pipelines configuration for a repository. properties: enabled: type: boolean description: Whether Pipelines is enabled for the repository. repository: $ref: '#/components/schemas/repository' 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 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 ScreenLookAndFeel: required: - background type: object properties: background: type: string example: example_value backgroundAttachment: type: string nullable: true example: example_value backgroundBlendMode: type: string nullable: true example: example_value backgroundClip: type: string nullable: true example: example_value backgroundColor: type: string nullable: true example: example_value backgroundImage: type: string nullable: true example: example_value backgroundOrigin: type: string nullable: true example: example_value backgroundPosition: type: string nullable: true example: example_value backgroundRepeat: type: string nullable: true example: example_value backgroundSize: type: string nullable: true example: example_value layer: type: object properties: width: type: string height: type: string nullable: true example: example_value gutterTop: type: string nullable: true example: example_value gutterRight: type: string nullable: true example: example_value gutterBottom: type: string nullable: true example: example_value gutterLeft: type: string nullable: true example: example_value RetentionPeriod: required: - number - units type: object properties: number: type: integer description: The number of units for the retention period. format: int32 example: 10 units: type: string description: The unit of time that the retention period is measured in. enum: - NANOS - MICROS - MILLIS - SECONDS - MINUTES - HOURS - HALF_DAYS - DAYS - WEEKS - MONTHS - YEARS - DECADES - CENTURIES - MILLENNIA - ERAS - FOREVER example: NANOS Group: required: - name - type - id type: object properties: type: type: string default: group enum: - group example: group name: type: string example: Example Title id: type: string example: abc123 _links: $ref: '#/components/schemas/GenericLinks' ContentPropertyArray: required: - _links - limit - results - size - start type: object properties: results: type: array items: $ref: '#/components/schemas/ContentProperty' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 _links: $ref: '#/components/schemas/GenericLinks' UserArray: required: - results type: object properties: results: type: array items: $ref: '#/components/schemas/User' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 totalSize: type: integer format: int64 default: 0 description: 'This property will return total count of the objects before pagination is applied. This value is returned if `shouldReturnTotalSize` is set to `true`.' example: 10 _links: $ref: '#/components/schemas/GenericLinks' Label: required: - id - label - name - prefix type: object properties: prefix: type: string example: example_value name: type: string example: Example Title id: type: string example: abc123 label: type: string example: Example Title application_property: additionalProperties: true type: object title: Application Property description: "An application property. It is a caller defined JSON object that Bitbucket will store and return. \nThe `_attributes` field at its top level can be used to control who is allowed to read and update the property. \nThe keys of the JSON object must match an allowed pattern. For details, \nsee [Application properties](/cloud/bitbucket/application-properties/).\n" properties: _attributes: type: array items: type: string enum: - public - read_only example: [] 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' ContentProperty: required: - _links - id - key - value type: object additionalProperties: true properties: id: type: string example: abc123 key: type: string example: example_value value: oneOf: - type: array items: type: string - type: boolean - type: object additionalProperties: true properties: {} - type: string description: The value of the content property. This can be empty or a complex object. example: example_value version: required: - message - minorEdit - number - when type: object additionalProperties: true properties: when: type: string format: date-time message: type: string number: type: integer format: int32 minorEdit: type: boolean contentTypeModified: type: boolean description: True if content type is modifed in this version (e.g. page to blog) example: example_value _links: $ref: '#/components/schemas/GenericLinks' _expandable: type: object properties: content: type: string additionalProperties: type: string example: example_value ContentChildren: type: object additionalProperties: true properties: attachment: $ref: '#/components/schemas/ContentArray' comment: $ref: '#/components/schemas/ContentArray' page: $ref: '#/components/schemas/ContentArray' _expandable: type: object additionalProperties: true properties: attachment: type: string comment: type: string page: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' 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: {} LookAndFeel: required: - bordersAndDividers - content - header - headings - links - menus type: object properties: headings: required: - color type: object properties: color: type: string example: example_value links: required: - color type: object properties: color: type: string example: example_value menus: $ref: '#/components/schemas/MenusLookAndFeel' header: $ref: '#/components/schemas/HeaderLookAndFeel' horizontalHeader: $ref: '#/components/schemas/HorizontalHeaderLookAndFeel' content: $ref: '#/components/schemas/ContentLookAndFeel' bordersAndDividers: required: - color type: object properties: color: type: string example: example_value spaceReference: type: object nullable: true example: example_value SpaceWatch: required: - type - watcher type: object properties: type: type: string example: example_value watcher: $ref: '#/components/schemas/WatchUser' spaceKey: type: string example: example_value labelName: type: string example: example_value prefix: type: string example: example_value treeentry: type: object title: Tree Entry 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 path: type: string description: The path in the repository example: example_value commit: $ref: '#/components/schemas/commit' required: - type additionalProperties: true OperationCheckResult: required: - operation - targetType type: object properties: operation: type: string description: The operation itself. enum: - administer - archive - clear_permissions - copy - create - create_space - delete - export - move - purge - purge_version - read - restore - restrict_content - update - use example: administer targetType: type: string description: The space or content type that the operation applies to. Could be one of- - application - page - blogpost - comment - attachment - space example: example_value description: An operation and the target entity that it applies to, e.g. create page. 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 ContentLookAndFeel: type: object properties: screen: $ref: '#/components/schemas/ScreenLookAndFeel' container: $ref: '#/components/schemas/ContainerLookAndFeel' header: $ref: '#/components/schemas/ContainerLookAndFeel' body: $ref: '#/components/schemas/ContainerLookAndFeel' AsyncContentBody: type: object properties: value: type: string example: example_value representation: type: string enum: - view - export_view - styled_view - storage - editor - editor2 - anonymous_export_view - wiki - atlas_doc_format example: view renderTaskId: type: string example: '500123' error: type: string example: example_value status: description: Rerunning is reserved for when the job is working, but there is a previous run's value in the cache. You may choose to continue polling, or use the cached value. type: string enum: - WORKING - QUEUED - FAILED - COMPLETED - RERUNNING example: WORKING embeddedContent: type: array items: $ref: '#/components/schemas/EmbeddedContent' example: [] webresource: $ref: '#/components/schemas/WebResourceDependencies' mediaToken: type: object properties: collectionIds: type: array items: type: string contentId: type: string expiryDateTime: type: string fileIds: type: array items: type: string token: type: string example: example_value _expandable: type: object properties: content: type: string embeddedContent: type: string webresource: type: string mediaToken: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' paginated_treeentries: type: object title: Paginated Tree Entry description: A paginated list of commit_file and/or commit_directory 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/treeentry' minItems: 0 uniqueItems: true example: [] additionalProperties: false NavigationLookAndFeel: required: - color - hoverOrFocus type: object nullable: true properties: color: type: string example: example_value highlightColor: type: string nullable: true example: example_value hoverOrFocus: required: - backgroundColor - color type: object properties: backgroundColor: type: string color: type: string example: example_value 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 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 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 LabelArray: required: - results - size type: object properties: results: type: array items: $ref: '#/components/schemas/Label' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 _links: $ref: '#/components/schemas/GenericLinks' Space: required: - _expandable - _links - key - name - status - type nullable: true type: object properties: id: type: integer format: int64 example: abc123 key: type: string example: example_value name: type: string example: Example Title icon: $ref: '#/components/schemas/Icon' description: type: object properties: plain: $ref: '#/components/schemas/SpaceDescription' view: $ref: '#/components/schemas/SpaceDescription' _expandable: type: object properties: view: type: string plain: type: string example: A sample description. homepage: $ref: '#/components/schemas/Content' type: type: string example: example_value metadata: type: object properties: labels: $ref: '#/components/schemas/LabelArray' _expandable: type: object example: example_value operations: type: array items: $ref: '#/components/schemas/OperationCheckResult' example: [] permissions: type: array items: $ref: '#/components/schemas/SpacePermission' example: [] status: type: string example: example_value settings: $ref: '#/components/schemas/SpaceSettings' theme: $ref: '#/components/schemas/Theme' lookAndFeel: $ref: '#/components/schemas/LookAndFeel' history: required: - createdDate type: object properties: createdDate: type: string format: date-time createdBy: $ref: '#/components/schemas/User' example: example_value _expandable: type: object properties: settings: type: string metadata: type: string operations: type: string lookAndFeel: type: string permissions: type: string icon: type: string description: type: string theme: type: string history: type: string homepage: type: string identifiers: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' GenericLinks: type: object additionalProperties: oneOf: - type: object additionalProperties: true - type: string 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 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 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 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 SearchFieldLookAndFeel: required: - backgroundColor - color type: object nullable: true properties: backgroundColor: type: string example: example_value color: type: string example: example_value 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 EmbeddedContent: type: object additionalProperties: true properties: entityId: type: integer format: int64 example: '500123' entityType: type: string example: example_value entity: $ref: '#/components/schemas/Embeddable' WebResourceDependencies: type: object properties: _expandable: type: object additionalProperties: true properties: uris: oneOf: - type: string - type: object additionalProperties: true example: example_value keys: type: array items: type: string example: [] contexts: type: array items: type: string example: [] uris: type: object properties: all: oneOf: - type: array items: type: string - type: string css: oneOf: - type: array items: type: string - type: string js: oneOf: - type: array items: type: string - type: string _expandable: type: object additionalProperties: true properties: css: oneOf: - type: array items: type: string - type: string js: oneOf: - type: array items: type: string - type: string example: example_value tags: type: object properties: all: type: string css: type: string data: type: string js: type: string _expandable: type: object additionalProperties: true example: example_value superbatch: $ref: '#/components/schemas/SuperBatchWebResources' team: allOf: - $ref: '#/components/schemas/account' - type: object title: Team description: A team object. properties: links: $ref: '#/components/schemas/team_links' additionalProperties: true project_branching_model: allOf: - $ref: '#/components/schemas/object' - type: object title: Project Branching Model description: A project's branching model properties: branch_types: type: array description: The active branch types. items: type: object properties: kind: type: string description: The kind of branch. enum: - feature - bugfix - release - hotfix prefix: type: string description: The prefix for this branch type. A branch with this prefix will be classified as per `kind`. The prefix must be a valid prefix for a branch and must always exist. It cannot be blank, empty or `null`. required: - kind - prefix additionalProperties: false minItems: 0 maxItems: 4 uniqueItems: true development: type: object properties: name: type: string description: Name of the target branch. If inherited by a repository, it will default to the main branch if the specified branch does not exist. use_mainbranch: type: boolean description: Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`). required: - name - use_mainbranch additionalProperties: false production: type: object properties: name: type: string description: Name of the target branch. If inherited by a repository, it will default to the main branch if the specified branch does not exist. use_mainbranch: type: boolean description: Indicates if the setting points at an explicit branch (`false`) or tracks the main branch (`true`). required: - name - use_mainbranch additionalProperties: false 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 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 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 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' Theme: required: - themeKey type: object properties: themeKey: type: string example: example_value name: type: string example: Example Title description: type: string example: A sample description. icon: $ref: '#/components/schemas/Icon' _links: $ref: '#/components/schemas/GenericLinks' 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 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 SpaceWatchArray: required: - limit - results - size - start type: object properties: results: type: array items: $ref: '#/components/schemas/SpaceWatch' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 _links: $ref: '#/components/schemas/GenericLinks' 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. pipeline_cache_content_uri: type: object title: Pipeline Cache Content URI description: A representation of the location of pipeline cache content. properties: uri: type: string format: uri description: The uri for pipeline cache content. example: https://www.example.com Container: type: object nullable: true additionalProperties: true description: 'Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment)' User: required: - type type: object additionalProperties: true nullable: true properties: type: type: string enum: - known - unknown - anonymous - user example: known username: $ref: '#/components/schemas/GenericUserName' userKey: $ref: '#/components/schemas/GenericUserKey' accountId: $ref: '#/components/schemas/GenericAccountId' accountType: type: string description: The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app. enum: - atlassian - app - '' example: atlassian email: nullable: true type: string description: The email address of the user. Depending on the user's privacy setting, this may return an empty string. example: user@example.com publicName: type: string description: The public name or nickname of the user. Will always contain a value. example: example_value profilePicture: $ref: '#/components/schemas/Icon' displayName: nullable: true type: string description: The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName. example: example_value timeZone: nullable: true type: string description: This displays user time zone. Depending on the user's privacy setting, this may return null. example: example_value isExternalCollaborator: type: boolean description: Whether the user is an external collaborator user example: true externalCollaborator: type: boolean description: Whether the user is an external collaborator user example: true operations: nullable: true type: array items: $ref: '#/components/schemas/OperationCheckResult' example: [] details: $ref: '#/components/schemas/UserDetails' personalSpace: $ref: '#/components/schemas/Space' _expandable: type: object properties: operations: type: string details: type: string personalSpace: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' 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. WatchArray: required: - _links - limit - results - size - start type: object properties: results: type: array items: $ref: '#/components/schemas/Watch' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 _links: $ref: '#/components/schemas/GenericLinks' GroupArray: required: - limit - results - size - start type: object properties: results: type: array items: $ref: '#/components/schemas/Group' example: [] start: type: integer format: int32 example: 10 limit: type: integer format: int32 example: 10 size: type: integer format: int32 example: 10 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 Content: required: - status - type nullable: true type: object additionalProperties: true properties: id: type: string example: abc123 type: type: string description: Can be "page", "blogpost", "attachment" or "content" example: example_value status: type: string example: example_value title: type: string example: Example Title space: $ref: '#/components/schemas/Space' history: $ref: '#/components/schemas/ContentHistory' version: $ref: '#/components/schemas/Version' ancestors: nullable: true type: array items: $ref: '#/components/schemas/Content' example: [] operations: type: array items: $ref: '#/components/schemas/OperationCheckResult' example: [] children: $ref: '#/components/schemas/ContentChildren' childTypes: $ref: '#/components/schemas/ContentChildType' descendants: $ref: '#/components/schemas/ContentChildren' container: $ref: '#/components/schemas/Container' body: type: object properties: view: $ref: '#/components/schemas/ContentBody' export_view: $ref: '#/components/schemas/ContentBody' styled_view: $ref: '#/components/schemas/ContentBody' storage: $ref: '#/components/schemas/ContentBody' wiki: $ref: '#/components/schemas/ContentBody' editor: $ref: '#/components/schemas/ContentBody' editor2: $ref: '#/components/schemas/ContentBody' anonymous_export_view: $ref: '#/components/schemas/ContentBody' atlas_doc_format: $ref: '#/components/schemas/ContentBody' dynamic: $ref: '#/components/schemas/ContentBody' raw: $ref: '#/components/schemas/ContentBody' _expandable: type: object properties: editor: type: string view: type: string export_view: type: string styled_view: type: string storage: type: string editor2: type: string anonymous_export_view: type: string atlas_doc_format: type: string wiki: type: string dynamic: type: string raw: type: string example: example_value restrictions: type: object properties: read: $ref: '#/components/schemas/ContentRestriction' update: $ref: '#/components/schemas/ContentRestriction' _expandable: type: object properties: read: type: string update: type: string _links: $ref: '#/components/schemas/GenericLinks' example: example_value metadata: $ref: '#/components/schemas/ContentMetadata' macroRenderedOutput: type: object additionalProperties: type: object example: example_value extensions: type: object example: example_value _expandable: type: object properties: childTypes: type: string container: type: string metadata: type: string operations: type: string children: type: string restrictions: type: string history: type: string ancestors: type: string body: type: string version: type: string descendants: type: string space: type: string extensions: type: string schedulePublishDate: type: string schedulePublishInfo: type: string macroRenderedOutput: type: string example: example_value _links: $ref: '#/components/schemas/GenericLinks' description: Base object for all content types. GenericUserName: type: string nullable: true description: 'This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.' examples: repository: 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 Bitbucket repository created_on: '2023-01-15T10:30:00.000Z' updated_on: '2024-01-15T14:45:30.000Z' size: 1048576 language: javascript has_issues: true has_wiki: true fork_policy: allow_forks undefined: id: 12345 created_on: '2023-10-15T14:30:00.000000+00:00' updated_on: '2023-10-15T15:45:00.000000+00:00' content: raw: This looks good to me! markup: markdown html:

This looks good to me!

user: display_name: John Doe uuid: '{a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6}' username: johndoe type: user deleted: false parent: id: 12340 inline: to: 15 from: 10 path: src/main.py type: pullrequest_comment pullrequest: id: 789 title: Add new feature type: pullrequest resolution: status: resolved timestamp: '2023-10-15T16:00:00.000000+00:00' pending: false version: links: self: href: https://api.example.com/versions/123 name: v1.0.0 name: v1.0.0 id: 123 deploy-key_2: key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDak9i... repository: uuid: '{1234abcd-5678-efgh-9012-ijklmnopqrst}' name: my-repository full_name: myworkspace/my-repository comment: deploy@example.com label: Production Deploy Key added_on: '2024-01-15T10:30:00Z' last_used: '2024-01-20T14:45:00Z' links: self: href: https://api.bitbucket.org/2.0/repositories/myworkspace/my-repository/deploy-keys/123 name: Production Deploy Key owner: uuid: '{abcd1234-efgh-5678-ijkl-9012mnopqrst}' username: myworkspace display_name: My Workspace pipeline-variable_2: uuid: 3c7b8a9e-1234-5678-90ab-cdef12345678 key: API_TOKEN value: my-secret-value secured: true pipeline-variable_2_4: uuid: 3c7f0a9e-5b2d-4e8f-9a1c-6d4e2f8b3a7e key: DATABASE_URL value: https://example.com/db secured: false paginated-tree-entry_2: size: 42 page: 1 pagelen: 10 next: https://api.example.com/repositories/myrepo/commits/abc123/tree?page=2 previous: https://api.example.com/repositories/myrepo/commits/abc123/tree?page=0 values: [] pipeline-schedule_2: uuid: 123e4567-e89b-12d3-a456-426614174000 enabled: true target: ref_type: branch ref_name: main cron_pattern: 0 0 12 * * ? * created_on: '2023-11-15T10:30:00Z' updated_on: '2023-11-20T14:45:30Z' tag_2: message: Release version 1.0.0 date: '2024-01-15T14:30:00Z' tagger: name: John Doe email: john.doe@example.com commit-comment_2: commit: sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e message: Fix all the bugs author: name: Monalisa Octocat email: octocat@github.com date: '2011-04-14T16:00:49Z' committer: name: Monalisa Octocat email: octocat@github.com date: '2011-04-14T16:00:49Z' issue-change_2: type: issue_change links: self: href: https://api.bitbucket.org/2.0/repositories/example/repo/issues/42/changes/1 name: 'Issue Change #1' issue: href: https://api.bitbucket.org/2.0/repositories/example/repo/issues/42 name: 'Issue #42' name: Status update created_on: '2024-01-15T10:30:00Z' user: type: user uuid: '{abc123}' display_name: John Doe username: johndoe issue: type: issue id: 42 title: Example issue title changes: state: old: new new: open assignee: old: janedoe new: johndoe priority: old: minor new: major message: raw: Changed priority and assigned to myself markup: markdown html:

Changed priority and assigned to myself

project-user-permission: type: project-user-permission links: self: href: https://api.example.com/projects/123/permissions/456 name: Project Permission permission: admin user: id: 123 name: john.doe email: john.doe@example.com project: id: 456 key: PROJ name: Example Project issue-comment_2: issue: id: 1 title: Bug in login functionality description: Users cannot log in with valid credentials status: open created_at: '2024-01-15T10:30:00Z' id: 101 author: john.doe comment: I can confirm this issue. It happens on Chrome browser. created_at: '2024-01-15T14:45:00Z' project_2: links: html: href: https://bitbucket.org/projects/example-project name: Example Project avatar: href: https://bitbucket.org/projects/example-project/avatar.png name: Project Avatar uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' key: PROJ owner: type: team uuid: '{b2c3d4e5-f6a7-8901-bcde-f12345678901}' username: example-team display_name: Example Team name: Example Project description: This is an example Bitbucket project for organizing repositories is_private: true created_on: '2024-01-15T10:30:00.000Z' updated_on: '2024-01-20T14:45:00.000Z' has_publicly_visible_repos: false application-property_2: _attributes: read: - admin - contributor write: - admin customKey1: value1 customKey2: 123 customKey3: nestedProperty: true pipeline-variable_2_3: uuid: 3c7b8a9e-4d2f-4a1b-9c3e-5f6a7b8c9d0e key: API_KEY value: my-secret-value secured: true workspace-membership: links: self: href: https://api.bitbucket.org/2.0/workspaces/my-workspace/members/john-doe name: self user: type: user uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' display_name: John Doe username: john-doe workspace: type: workspace uuid: '{b2c3d4e5-f6a7-8901-bcde-f12345678901}' name: My Workspace slug: my-workspace account: links: self: href: https://api.bitbucket.org/2.0/users/example_user avatar: href: https://bitbucket.org/account/example_user/avatar/32/ created_on: '2023-01-15T14:30:00Z' display_name: John Doe username: john_doe_123 uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' webhook-subscription_2_2: uuid: '{d6a8e1a7-8b5c-4f3e-9d2a-1b3c4d5e6f7a}' url: https://example.com/webhook description: Webhook for pull request events subject_type: repository subject: {} active: true created_at: '2024-01-15T10:30:00Z' events: - pullrequest:created - pullrequest:updated - pullrequest:approved - repo:push secret_set: true secret: my-webhook-secret-key-123 branching-model-settings_2: links: self: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/branching-model/settings name: Branching Model Settings branch_types: - enabled: true kind: feature prefix: feature/ - enabled: true kind: bugfix prefix: bugfix/ - enabled: true kind: release prefix: release/ - enabled: false kind: hotfix prefix: hotfix/ development: is_valid: true name: develop use_mainbranch: false production: is_valid: true name: main use_mainbranch: false enabled: true component: links: self: href: https://api.example.com/repositories/my-repo/components/123 name: bug-fixes name: Authentication id: 123 milestone: links: self: href: https://api.example.com/repositories/my-repo/milestones/1 name: v1.0.0 name: v1.0.0 id: 1 repository-user-permission: type: repository_user_permission permission: write user: username: johndoe display_name: John Doe uuid: '{12345678-1234-1234-1234-123456789abc}' type: user repository: name: my-repo full_name: johndoe/my-repo uuid: '{87654321-4321-4321-4321-cba987654321}' type: repository links: self: href: https://api.bitbucket.org/2.0/repositories/johndoe/my-repo/permissions-config/users/johndoe name: Repository User Permission user: links: self: href: https://api.bitbucket.org/2.0/users/example_user html: href: https://bitbucket.org/example_user avatar: href: https://avatar-management.services.atlassian.com/default/48 account_id: 5d2a8f5c9e8e4b0d8f6a3c1b account_status: active has_2fa_enabled: true nickname: johndoe is_staff: false website: https://example.com snippet_2: id: 12345 title: Example Code Snippet scm: git created_on: '2024-01-15T10:30:00Z' updated_on: '2024-01-15T14:45:00Z' owner: username: john_doe display_name: John Doe creator: username: jane_smith display_name: Jane Smith is_private: true project-group-permission: type: project-group-permission links: self: href: https://api.example.com/projects/123/permissions/groups/456 name: Project Group Permission permission: admin group: name: developers id: 456 project: key: PROJ name: Example Project id: 123 application-property_4: _attributes: public: true readOnly: false customKey: customValue anotherProperty: 123 nestedObject: field1: value1 field2: true workspace: links: avatar: href: https://bitbucket.org/workspaces/example-workspace/avatar name: Avatar html: href: https://bitbucket.org/example-workspace name: HTML members: href: https://api.bitbucket.org/2.0/workspaces/example-workspace/members name: Members owners: href: https://api.bitbucket.org/2.0/workspaces/example-workspace/owners name: Owners projects: href: https://api.bitbucket.org/2.0/workspaces/example-workspace/projects name: Projects repositories: href: https://api.bitbucket.org/2.0/repositories/example-workspace name: Repositories snippets: href: https://api.bitbucket.org/2.0/snippets/example-workspace name: Snippets self: href: https://api.bitbucket.org/2.0/workspaces/example-workspace name: Self uuid: '{1234abcd-12ab-34cd-56ef-1234567890ab}' name: Example Workspace slug: example-workspace is_private: false created_on: '2023-01-15T10:30:00Z' updated_on: '2024-01-20T14:45:30Z' undefined_2_2: _links: self: https://api.example.com/resource next: https://api.example.com/resource?start=10 base: https://api.example.com limit: 10 results: [] size: 0 start: 0 snippet-commit: links: self: href: https://api.bitbucket.org/2.0/snippets/myworkspace/abc123/commits/def456 name: self html: href: https://bitbucket.org/snippets/myworkspace/abc123/commits/def456 name: html diff: href: https://api.bitbucket.org/2.0/snippets/myworkspace/abc123/commits/def456/diff name: diff snippet: id: abc123 title: Example Snippet created_on: '2023-01-15T10:30:00Z' account_3: links: self: href: https://api.bitbucket.org/2.0/users/example_user avatar: href: https://bitbucket.org/account/example_user/avatar/ created_on: '2024-01-15T14:30:00Z' display_name: Example User username: example_user uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' pipeline-ssh-key-pair: private_key: '-----BEGIN OPENSSH PRIVATE KEY----- b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn NhAAAAAwEAAQAAAYEAw5... -----END OPENSSH PRIVATE KEY-----' public_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDDl5Z8xYzKj3pQ7vXmF2wN4Hx9rL8mK1pR9tE= user@example.com deployment-environment_2: uuid: 123e4567-e89b-12d3-a456-426614174000 name: production undefined_2: id: 12345 count: 8742 deployment: uuid: 123e4567-e89b-12d3-a456-426614174000 state: name: COMPLETED status: successful environment: uuid: 987e6543-e21b-45d3-a456-426614174999 name: production type: production release: uuid: 456e7890-e12b-34d5-a678-426614174111 name: v1.2.3 url: https://api.bitbucket.org/2.0/repositories/workspace/repo/deployments/releases/1 application-property: _attributes: - public - read_only customField1: example value customField2: 123 nestedObject: key: value commit_2: repository: name: my-repo full_name: myuser/my-repo uuid: '{12345678-1234-1234-1234-123456789012}' participants: user: username: john_doe display_name: John Doe uuid: '{87654321-4321-4321-4321-210987654321}' account_id: 557058:12345678-abcd-efgh-ijkl-123456789012 role: REVIEWER approved: true state: approved participated_on: '2023-11-15T14:30:00Z' snippet-comment_2: links: self: href: https://api.bitbucket.org/2.0/snippets/example/comments/1 name: Self Link html: href: https://bitbucket.org/snippets/example/comments/1 name: HTML Link snippet: {} branch-restriction_2: users: links: self: href: https://api.bitbucket.org/2.0/users/example_user created_on: '2023-01-15T10:30:00Z' display_name: John Doe username: john_doe uuid: '{12345678-1234-1234-1234-123456789abc}' groups: links: self: href: https://api.bitbucket.org/2.0/groups/example_workspace/developers name: developers html: href: https://bitbucket.org/example_workspace/developers name: developers owner: created_on: '2022-05-20T08:15:00Z' display_name: Jane Smith username: jane_smith uuid: '{87654321-4321-4321-4321-cba987654321}' workspace: slug: example_workspace name: Example Workspace uuid: '{abcdef12-abcd-abcd-abcd-abcdef123456}' name: Developers slug: developers full_slug: example_workspace:developers application-property_3: _attributes: readPermission: public writePermission: admin customKey1: customValue1 customKey2: 12345 customKey3: nestedProperty: true report-annotation: external_id: VULN-2024-001 uuid: 123e4567-e89b-12d3-a456-426614174000 annotation_type: VULNERABILITY path: src/main/java/com/example/Application.java line: 42 summary: SQL injection vulnerability detected details: User input is directly concatenated into SQL query without proper sanitization. This could allow an attacker to execute arbitrary SQL commands. result: FAILED severity: HIGH link: https://security-scanner.example.com/reports/VULN-2024-001 created_on: '2024-01-15T10:30:00Z' updated_on: '2024-01-15T14:45:00Z' pipeline-step: uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 started_on: '2024-01-15T10:30:00Z' completed_on: '2024-01-15T10:35:00Z' state: {} image: {} setup_commands: [] script_commands: [] undefined_4: number: 30 units: DAYS branching-model-settings: links: self: href: https://api.bitbucket.org/2.0/repositories/myworkspace/myrepo/branching-model/settings name: Branching Model Settings branch_types: - enabled: true kind: feature prefix: feature/ - enabled: true kind: bugfix prefix: bugfix/ - enabled: true kind: release prefix: release/ - enabled: false kind: hotfix prefix: hotfix/ development: is_valid: true name: develop use_mainbranch: false production: is_valid: true name: main use_mainbranch: false enabled: true pipeline_2: uuid: '{9af25a37-e228-4eca-a964-08f8e8a4f3dc}' build_number: 42 creator: type: account uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' display_name: John Doe account_id: 5d5e6f7g8h9i0j1k nickname: johndoe repository: type: repository uuid: '{b2c3d4e5-f6a7-8901-bcde-f12345678901}' full_name: myworkspace/myrepo name: myrepo target: type: pipeline_target ref_type: branch ref_name: main commit: type: commit hash: a1b2c3d4e5f6 trigger: type: pipeline_trigger trigger_type: push state: type: pipeline_state name: COMPLETED result: type: pipeline_state_completed_successful name: SUCCESSFUL variables: uuid: '{c3d4e5f6-a7b8-9012-cdef-123456789012}' key: DATABASE_URL value: postgres://localhost:5432/mydb secured: false created_on: '2024-01-15T10:30:00.000Z' completed_on: '2024-01-15T10:45:30.000Z' build_seconds_used: 930 account_2: links: self: href: https://api.bitbucket.org/2.0/users/example_user avatar: href: https://bitbucket.org/account/example_user/avatar/32/ created_on: '2023-01-15T10:30:00.000Z' display_name: John Doe username: john_doe_123 uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' ssh-account-key_2: owner: id: user123 username: john.doe email: john.doe@example.com key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC7... fingerprint: SHA256:abcd1234efgh5678ijkl9012mnop3456 label: Work Laptop created_at: '2024-01-15T10:30:00Z' project-deploy-key_2: key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC... project: key: PROJ name: My Project comment: deploy@example.com 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 created_by: username: johndoe display_name: John Doe uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' pipeline-cache-content-uri: uri: https://example.com/pipeline/cache/content/12345 issue_2: links: self: href: https://api.example.com/repositories/myrepo/issues/123 name: 'Issue #123' html: href: https://example.com/myrepo/issues/123 name: View Issue comments: href: https://api.example.com/repositories/myrepo/issues/123/comments name: Comments attachments: href: https://api.example.com/repositories/myrepo/issues/123/attachments name: Attachments watch: href: https://api.example.com/repositories/myrepo/issues/123/watch name: Watch vote: href: https://api.example.com/repositories/myrepo/issues/123/vote name: Vote id: 123 repository: {} title: Fix login bug on mobile devices reporter: {} assignee: {} created_on: '2023-10-15T14:30:00Z' updated_on: '2023-10-16T09:15:00Z' edited_on: '2023-10-16T09:15:00Z' state: open kind: bug priority: major milestone: {} version: {} component: {} votes: 5 content: raw: 'Users are unable to login on mobile devices. Steps to reproduce: 1. Open app on mobile 2. Enter credentials 3. Click login' markup: markdown html: '

Users are unable to login on mobile devices. Steps to reproduce:

  1. Open app on mobile
  2. Enter credentials
  3. Click login
' effective-repository-branching-model: branch_types: - kind: feature prefix: feature/ - kind: bugfix prefix: bugfix/ - kind: release prefix: release/ - kind: hotfix prefix: hotfix/ development: name: develop use_mainbranch: false production: name: main use_mainbranch: true undefined_3: id: 12345 count: 8567 commit-status_2: links: self: href: https://api.bitbucket.org/2.0/repositories/my-workspace/my-repo/commit/a1b2c3d4/statuses/build/bb-deploy-123 name: Self Link commit: href: https://api.bitbucket.org/2.0/repositories/my-workspace/my-repo/commit/a1b2c3d4 name: Commit Link uuid: '{12345678-1234-5678-1234-567812345678}' 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-11-15T10:30:00Z' updated_on: '2023-11-15T10:45:00Z' project-branching-model: branch_types: - kind: feature prefix: feature/ - kind: bugfix prefix: bugfix/ - kind: release prefix: release/ - kind: hotfix prefix: hotfix/ development: name: develop use_mainbranch: false production: name: main use_mainbranch: true pipeline-variable_2_2: uuid: 123e4567-e89b-12d3-a456-426614174000 key: DATABASE_URL value: postgresql://localhost:5432/mydb secured: false commit-report_2: uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 title: Security Scan Report details: Automated security vulnerability scan for commit external_id: security-scan-12345 reporter: SecureCode Scanner v2.1 link: https://example.com/reports/security-scan-12345 remote_link_enabled: true logo_url: https://example.com/logos/securecode.png report_type: SECURITY result: PASSED data: vulnerabilities_found: 0 scanned_files: 42 created_on: '2024-01-15T10:30:00Z' updated_on: '2024-01-15T10:35:00Z' pipeline-known-host_2: uuid: 123e4567-e89b-12d3-a456-426614174000 hostname: github.com public_key: type: ssh-rsa key: AAAAB3NzaC1yc2EAAAADAQABAAABAQC7... md5_fingerprint: 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48 sha256_fingerprint: SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8 webhook-subscription_2: uuid: '{a1b2c3d4-e5f6-7890-abcd-ef1234567890}' url: https://example.com/webhooks/bitbucket description: Webhook for monitoring pull request events subject_type: repository subject: type: repository name: my-repo active: true created_at: '2024-01-15T10:30:00Z' events: - pullrequest:created - pullrequest:approved - pullrequest:fulfilled - repo:push secret_set: true secret: my-webhook-secret-key-12345 repository-group-permission: type: repository_group_permission links: self: href: https://api.example.com/repositories/my-repo/permissions/groups/developers name: developers-permission permission: write group: slug: developers name: Developers repository: slug: my-repo name: My Repository pipelines-configuration: enabled: true repository: uuid: '{12345678-1234-1234-1234-123456789abc}' name: my-repository full_name: myworkspace/my-repository type: repository paginated-tree-entry: size: 42 page: 1 pagelen: 10 next: https://api.example.com/repositories/user/repo/tree/main?page=2 previous: https://api.example.com/repositories/user/repo/tree/main?page=0 values: [] branching-model_2: branch_types: - kind: feature prefix: feature/ - kind: bugfix prefix: bugfix/ - kind: release prefix: release/ - kind: hotfix prefix: hotfix/ development: name: develop use_mainbranch: false production: name: main use_mainbranch: true parameters: bodyConversionExpand: name: expand in: query description: "A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the\n`to` conversion format and may be irrelevant for certain conversions (e.g. `macroRenderedOutput` is redundant when\nconverting to `view` format). \n\nIf rendering to `view` format, and the body content being converted includes arbitrary nested content (such as macros); then it is \nnecessary to include webresource expands in the request. Webresources for content body are the batched JS and CSS dependencies for\nany nested dynamic content (i.e. macros).\n\n- `embeddedContent` returns metadata for nested content (e.g. page included using page include macro)\n- `mediaToken` returns JWT token for retrieving attachment data from Media API\n- `macroRenderedOutput` additionally converts body to view format\n- `webresource.superbatch.uris.js` returns all common JS dependencies as static URLs\n- `webresource.superbatch.uris.css` returns all common CSS dependencies as static URLs\n- `webresource.superbatch.uris.all` returns all common dependencies as static URLs\n- `webresource.superbatch.tags.all` returns all common JS dependencies as html `