> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # bitbucket-repos > Repositories, branches, tags, commits **Server path:** `/bitbucket-repos` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------- | | [`bitbucket_repos_create_branch`](#bitbucket_repos_create_branch) | Create a branch | | [`bitbucket_repos_create_repository`](#bitbucket_repos_create_repository) | Create a repository | | [`bitbucket_repos_create_tag`](#bitbucket_repos_create_tag) | Create a tag | | [`bitbucket_repos_create_webhook`](#bitbucket_repos_create_webhook) | Create a webhook for a repository | | [`bitbucket_repos_delete_branch`](#bitbucket_repos_delete_branch) | Delete a branch | | [`bitbucket_repos_delete_repository`](#bitbucket_repos_delete_repository) | Delete a repository | | [`bitbucket_repos_delete_tag`](#bitbucket_repos_delete_tag) | Delete a tag | | [`bitbucket_repos_delete_webhook`](#bitbucket_repos_delete_webhook) | Delete a webhook for a repository | | [`bitbucket_repos_fork_repository`](#bitbucket_repos_fork_repository) | Fork a repository | | [`bitbucket_repos_get_branch`](#bitbucket_repos_get_branch) | Get a branch | | [`bitbucket_repos_get_branching_model`](#bitbucket_repos_get_branching_model) | Get the branching model for a repository | | [`bitbucket_repos_get_branching_model_settings`](#bitbucket_repos_get_branching_model_settings) | Get the branching model config for a repository | | [`bitbucket_repos_get_commit`](#bitbucket_repos_get_commit) | Get a commit | | [`bitbucket_repos_get_diff`](#bitbucket_repos_get_diff) | Compare two commits | | [`bitbucket_repos_get_diffstat`](#bitbucket_repos_get_diffstat) | Compare two commit diff stats | | [`bitbucket_repos_get_file_content`](#bitbucket_repos_get_file_content) | Get file or directory contents | | [`bitbucket_repos_get_file_history`](#bitbucket_repos_get_file_history) | List commits that modified a file | | [`bitbucket_repos_get_repository`](#bitbucket_repos_get_repository) | Get a repository | | [`bitbucket_repos_get_tag`](#bitbucket_repos_get_tag) | Get a tag | | [`bitbucket_repos_get_webhook`](#bitbucket_repos_get_webhook) | Get a webhook for a repository | | [`bitbucket_repos_list_branches`](#bitbucket_repos_list_branches) | List open branches | | [`bitbucket_repos_list_commit_comments`](#bitbucket_repos_list_commit_comments) | List a commit's comments | | [`bitbucket_repos_list_commit_statuses`](#bitbucket_repos_list_commit_statuses) | List commit statuses for a commit | | [`bitbucket_repos_list_commits`](#bitbucket_repos_list_commits) | List commits | | [`bitbucket_repos_list_refs`](#bitbucket_repos_list_refs) | List branches and tags | | [`bitbucket_repos_list_repositories`](#bitbucket_repos_list_repositories) | List repositories in a workspace | | [`bitbucket_repos_list_repository_forks`](#bitbucket_repos_list_repository_forks) | List repository forks | | [`bitbucket_repos_list_repository_watchers`](#bitbucket_repos_list_repository_watchers) | List repositories watchers | | [`bitbucket_repos_list_tags`](#bitbucket_repos_list_tags) | List tags | | [`bitbucket_repos_list_webhooks`](#bitbucket_repos_list_webhooks) | List webhooks for a repository | | [`bitbucket_repos_update_repository`](#bitbucket_repos_update_repository) | Update a repository | | [`bitbucket_repos_update_webhook`](#bitbucket_repos_update_webhook) | Update a webhook for a repository | *** ## bitbucket\_repos\_create\_branch Create a branch **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `default_merge_strategy` | string | No | — | The default merge strategy for pull requests targeting this branch. | | `links` | object | No | — | The links value | | `merge_strategies` | string\[] | No | — | Available merge strategies for pull requests targeting this branch. | | `name` | string | No | — | The name of the ref. | | `target` | object | No | — | The target value | | `type` | string | Yes | — | The type value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "default_merge_strategy": { "type": "string", "description": "The default merge strategy for pull requests targeting this branch." }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." } } }, "merge_strategies": { "type": "array", "items": { "type": "string", "enum": [ "merge_commit", "squash", "fast_forward", "squash_fast_forward", "rebase_fast_forward", "rebase_merge" ] }, "description": "Available merge strategies for pull requests targeting this branch." }, "name": { "type": "string", "description": "The name of the ref." }, "target": { "description": "The target value" }, "type": { "type": "string", "description": "The type value" } }, "required": [ "PCID", "repo_slug", "workspace", "type" ] } ``` *** ## bitbucket\_repos\_create\_repository Create a repository **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `created_on` | string | No | — | Created On | | `description` | string | No | — | The description value | | `fork_policy` | string | No | — | Controls the rules for forking this repository. \* **allow\_forks**: unrestricted forking \* **no\_public\_forks**: restrict forking to private forks (forks cannot be made public later) \* **no\_forks**: deny all forking | | `full_name` | string | No | — | 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. | | `has_issues` | boolean | No | — | 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` | boolean | No | — | The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com. | | `is_private` | boolean | No | — | Is Private | | `language` | string | No | — | The language value | | `links` | object | No | — | The links value | | `mainbranch` | object | No | — | The mainbranch value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `parent` | object | No | — | Circular schema reference: #/components/schemas/repository | | `project` | object | No | — | The project value | | `scm` | string | No | — | The scm value | | `size` | integer | No | — | The size value | | `type` | string | No | — | The type value | | `updated_on` | string | No | — | Updated On | | `uuid` | string | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "created_on": { "type": "string", "description": "Created On" }, "description": { "type": "string", "description": "The description value" }, "fork_policy": { "type": "string", "description": "Controls the rules for forking this repository. * **allow_forks**: unrestricted forking * **no_public_forks**: restrict forking to private forks (forks cannot be made public later) * **no_forks**: deny all forking", "enum": [ "allow_forks", "no_public_forks", "no_forks" ] }, "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." }, "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." }, "is_private": { "type": "boolean", "description": "Is Private" }, "language": { "type": "string", "description": "The language value" }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "avatar": { "type": "object", "description": "A link to a resource related to this object." }, "pullrequests": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "forks": { "type": "object", "description": "A link to a resource related to this object." }, "watchers": { "type": "object", "description": "A link to a resource related to this object." }, "downloads": { "type": "object", "description": "A link to a resource related to this object." }, "clone": { "type": "array", "items": { "type": "object" }, "description": "The clone value" }, "hooks": { "type": "object", "description": "A link to a resource related to this object." } } }, "mainbranch": { "description": "The mainbranch value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "description": "The owner value" }, "parent": { "type": "object", "description": "Circular schema reference: #/components/schemas/repository" }, "project": { "description": "The project value" }, "scm": { "type": "string", "description": "The scm value", "enum": [ "git" ] }, "size": { "type": "integer", "description": "The size value" }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "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." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_create\_tag Create a tag **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `date` | string | No | — | The date that the tag was created, if available | | `links` | object | No | — | The links value | | `message` | string | No | — | The message associated with the tag, if available. | | `name` | string | No | — | The name of the ref. | | `tagger` | object | No | — | The tagger value | | `target` | object | No | — | The target value | | `type` | string | Yes | — | The type value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "date": { "type": "string", "description": "The date that the tag was created, if available" }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." } } }, "message": { "type": "string", "description": "The message associated with the tag, if available." }, "name": { "type": "string", "description": "The name of the ref." }, "tagger": { "description": "The tagger value" }, "target": { "description": "The target value" }, "type": { "type": "string", "description": "The type value" } }, "required": [ "PCID", "repo_slug", "workspace", "type" ] } ``` *** ## bitbucket\_repos\_create\_webhook Create a webhook for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `active` | boolean | No | — | The active value | | `created_at` | string | No | — | Created At | | `description` | string | No | — | A user-defined description of the webhook. | | `events` | string\[] | No | — | The events this webhook is subscribed to. | | `secret` | string | No | — | 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. | | `secret_set` | boolean | No | — | 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. | | `subject` | object | No | — | 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`. | | `subject_type` | string | No | — | The type of entity. Set to either `repository` or `workspace` based on where the subscription is defined. | | `type` | string | Yes | — | The type value | | `url` | string | No | — | The URL events get delivered to. | | `uuid` | string | No | — | The webhook's id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "active": { "type": "boolean", "description": "The active value" }, "created_at": { "type": "string", "description": "Created At" }, "description": { "type": "string", "description": "A user-defined description of the webhook." }, "events": { "type": "array", "items": { "type": "string", "enum": [ "issue:comment_created", "issue:created", "issue:updated", "pipeline:span_created", "project:updated", "pullrequest:approved", "pullrequest:changes_request_created", "pullrequest:changes_request_removed", "pullrequest:comment_created", "pullrequest:comment_deleted", "pullrequest:comment_reopened", "pullrequest:comment_resolved", "pullrequest:comment_updated", "pullrequest:created", "pullrequest:fulfilled", "pullrequest:push", "pullrequest:rejected", "pullrequest:unapproved", "pullrequest:updated", "repo:commit_comment_created", "repo:commit_status_created", "repo:commit_status_updated", "repo:created", "repo:deleted", "repo:fork", "repo:imported", "repo:push", "repo:transfer", "repo:updated" ] }, "description": "The events this webhook is subscribed to." }, "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." }, "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." }, "subject": { "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", "description": "The type value" } }, "required": [ "type" ] }, "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" ] }, "type": { "type": "string", "description": "The type value" }, "url": { "type": "string", "description": "The URL events get delivered to." }, "uuid": { "type": "string", "description": "The webhook's id" } }, "required": [ "PCID", "repo_slug", "workspace", "type" ] } ``` *** ## bitbucket\_repos\_delete\_branch Delete a branch **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Yes | — | The name of the branch. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name of the branch." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "name", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_delete\_repository Delete a repository **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `redirect_to` | string | No | — | If a repository has been moved to a new location, use this parameter to show users a friendly message in the Bitbucket UI that the repository has moved to a new location. However, a GET to this endpoint will still return a 404. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "redirect_to": { "type": "string", "description": "If a repository has been moved to a new location, use this parameter to show users a friendly message in the Bitbucket UI that the repository has moved to a new location. However, a GET to this endpoint will still return a 404." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_delete\_tag Delete a tag **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Yes | — | The name of the tag. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name of the tag." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "name", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_delete\_webhook Delete a webhook for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `uid` | string | Yes | — | Installed webhook's ID | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "uid": { "type": "string", "description": "Installed webhook's ID" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "uid", "workspace" ] } ``` *** ## bitbucket\_repos\_fork\_repository Fork a repository **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `created_on` | string | No | — | Created On | | `description` | string | No | — | The description value | | `fork_policy` | string | No | — | Controls the rules for forking this repository. \* **allow\_forks**: unrestricted forking \* **no\_public\_forks**: restrict forking to private forks (forks cannot be made public later) \* **no\_forks**: deny all forking | | `full_name` | string | No | — | 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. | | `has_issues` | boolean | No | — | 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` | boolean | No | — | The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com. | | `is_private` | boolean | No | — | Is Private | | `language` | string | No | — | The language value | | `links` | object | No | — | The links value | | `mainbranch` | object | No | — | The mainbranch value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `parent` | object | No | — | Circular schema reference: #/components/schemas/repository | | `project` | object | No | — | The project value | | `scm` | string | No | — | The scm value | | `size` | integer | No | — | The size value | | `type` | string | No | — | The type value | | `updated_on` | string | No | — | Updated On | | `uuid` | string | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "created_on": { "type": "string", "description": "Created On" }, "description": { "type": "string", "description": "The description value" }, "fork_policy": { "type": "string", "description": "Controls the rules for forking this repository. * **allow_forks**: unrestricted forking * **no_public_forks**: restrict forking to private forks (forks cannot be made public later) * **no_forks**: deny all forking", "enum": [ "allow_forks", "no_public_forks", "no_forks" ] }, "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." }, "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." }, "is_private": { "type": "boolean", "description": "Is Private" }, "language": { "type": "string", "description": "The language value" }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "avatar": { "type": "object", "description": "A link to a resource related to this object." }, "pullrequests": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "forks": { "type": "object", "description": "A link to a resource related to this object." }, "watchers": { "type": "object", "description": "A link to a resource related to this object." }, "downloads": { "type": "object", "description": "A link to a resource related to this object." }, "clone": { "type": "array", "items": { "type": "object" }, "description": "The clone value" }, "hooks": { "type": "object", "description": "A link to a resource related to this object." } } }, "mainbranch": { "description": "The mainbranch value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "description": "The owner value" }, "parent": { "type": "object", "description": "Circular schema reference: #/components/schemas/repository" }, "project": { "description": "The project value" }, "scm": { "type": "string", "description": "The scm value", "enum": [ "git" ] }, "size": { "type": "integer", "description": "The size value" }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "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." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_branch Get a branch **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Yes | — | The name of the branch. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name of the branch." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "name", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_branching\_model Get the branching model for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_branching\_model\_settings Get the branching model config for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_commit Get a commit **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `commit` | string | Yes | — | The commit's SHA1. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commit": { "type": "string", "description": "The commit's SHA1." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "commit", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_diff Compare two commits **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `spec` | string | Yes | — | A commit SHA (e.g. `3a8b42`) or a commit range using double dot notation (e.g. `3a8b42..9ff173`). | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `context` | integer | No | — | Generate diffs with \ lines of context instead of the usual three. | | `path` | string | No | — | Limit the diff to a particular file (this parameter can be repeated for multiple paths). | | `ignore_whitespace` | boolean | No | — | Generate diffs that ignore whitespace. | | `binary` | boolean | No | — | Generate diffs that include binary files, true if omitted. | | `renames` | boolean | No | — | Whether to perform rename detection, true if omitted. | | `merge` | boolean | No | — | This parameter is deprecated. The 'topic' parameter should be used instead. The 'merge' and 'topic' parameters cannot be both used at the same time. If true, the source commit is merged into the destination commit, and then a diff from the destination to the merge result is returned. If false, a simple 'two dot' diff between the source and destination is returned. True if omitted. | | `topic` | boolean | No | — | If true, returns 2-way 'three-dot' diff. This is a diff between the source commit and the merge base of the source commit and the destination commit. If false, a simple 'two dot' diff between the source and destination is returned. If omitted, defaults to true, ie. a 2 way 'three-dot' diff is returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "spec": { "type": "string", "description": "A commit SHA (e.g. `3a8b42`) or a commit range using double dot notation (e.g. `3a8b42..9ff173`)." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "context": { "type": "integer", "description": "Generate diffs with lines of context instead of the usual three." }, "path": { "type": "string", "description": "Limit the diff to a particular file (this parameter can be repeated for multiple paths)." }, "ignore_whitespace": { "type": "boolean", "description": "Generate diffs that ignore whitespace." }, "binary": { "type": "boolean", "description": "Generate diffs that include binary files, true if omitted." }, "renames": { "type": "boolean", "description": "Whether to perform rename detection, true if omitted." }, "merge": { "type": "boolean", "description": "This parameter is deprecated. The 'topic' parameter should be used instead. The 'merge' and 'topic' parameters cannot be both used at the same time. If true, the source commit is merged into the destination commit, and then a diff from the destination to the merge result is returned. If false, a simple 'two dot' diff between the source and destination is returned. True if omitted." }, "topic": { "type": "boolean", "description": "If true, returns 2-way 'three-dot' diff. This is a diff between the source commit and the merge base of the source commit and the destination commit. If false, a simple 'two dot' diff between the source and destination is returned. If omitted, defaults to true, ie. a 2 way 'three-dot' diff is returned." } }, "required": [ "PCID", "repo_slug", "spec", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_diffstat Compare two commit diff stats **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ignore_whitespace` | boolean | No | — | Generate diffs that ignore whitespace | | `merge` | boolean | No | — | This parameter is deprecated. The 'topic' parameter should be used instead. The 'merge' and 'topic' parameters cannot be both used at the same time. If true, the source commit is merged into the destination commit, and then a diffstat from the destination to the merge result is returned. If false, a simple 'two dot' diffstat between the source and destination is returned. True if omitted. | | `path` | string | No | — | Limit the diffstat to a particular file (this parameter can be repeated for multiple paths). | | `renames` | boolean | No | — | Whether to perform rename detection, true if omitted. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `spec` | string | Yes | — | A commit SHA (e.g. `3a8b42`) or a commit range using double dot notation (e.g. `3a8b42..9ff173`). | | `topic` | boolean | No | — | If true, returns 2-way 'three-dot' diff. This is a diff between the source commit and the merge base of the source commit and the destination commit. If false, a simple 'two dot' diff between the source and destination is returned. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ignore_whitespace": { "type": "boolean", "description": "Generate diffs that ignore whitespace" }, "merge": { "type": "boolean", "description": "This parameter is deprecated. The 'topic' parameter should be used instead. The 'merge' and 'topic' parameters cannot be both used at the same time. If true, the source commit is merged into the destination commit, and then a diffstat from the destination to the merge result is returned. If false, a simple 'two dot' diffstat between the source and destination is returned. True if omitted." }, "path": { "type": "string", "description": "Limit the diffstat to a particular file (this parameter can be repeated for multiple paths)." }, "renames": { "type": "boolean", "description": "Whether to perform rename detection, true if omitted." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "spec": { "type": "string", "description": "A commit SHA (e.g. `3a8b42`) or a commit range using double dot notation (e.g. `3a8b42..9ff173`)." }, "topic": { "type": "boolean", "description": "If true, returns 2-way 'three-dot' diff. This is a diff between the source commit and the merge base of the source commit and the destination commit. If false, a simple 'two dot' diff between the source and destination is returned." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "spec", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_file\_content Get file or directory contents **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `commit` | string | Yes | — | The commit's SHA1. | | `path` | string | Yes | — | Path to the file. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `format` | string | No | — | 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. | | `q` | string | No | — | Optional filter expression as per filtering and sorting. | | `sort` | string | No | — | Optional sorting parameter as per filtering and sorting. | | `max_depth` | integer | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commit": { "type": "string", "description": "The commit's SHA1." }, "path": { "type": "string", "description": "Path to the file." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "format": { "type": "string", "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.", "enum": [ "meta", "rendered" ] }, "q": { "type": "string", "description": "Optional filter expression as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Optional sorting parameter as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results)." }, "max_depth": { "type": "integer", "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": [ "PCID", "commit", "path", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_file\_history List commits that modified a file **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `commit` | string | Yes | — | The commit's SHA1. | | `path` | string | Yes | — | Path to the file. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `renames` | string | No | — | When `true`, Bitbucket will follow the history of the file across renames (this is the default behavior). This can be turned off by specifying `false`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Name of a response property sort the result by as per filtering and sorting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commit": { "type": "string", "description": "The commit's SHA1." }, "path": { "type": "string", "description": "Path to the file." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "renames": { "type": "string", "description": "When `true`, Bitbucket will follow the history of the file across renames (this is the default behavior). This can be turned off by specifying `false`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Name of a response property sort the result by as per [filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results)." } }, "required": [ "PCID", "commit", "path", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_repository Get a repository **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_tag Get a tag **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Yes | — | The name of the tag. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The name of the tag." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "name", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_get\_webhook Get a webhook for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `uid` | string | Yes | — | Installed webhook's ID | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "uid": { "type": "string", "description": "Installed webhook's ID" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "uid", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_branches List open branches **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. The `name` field is handled specially for branches in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return \['branch1', 'branch2', 'branch10'] instead of \['branch1', 'branch10', 'branch2']. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name` field is handled specially for branches in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return ['branch1', 'branch2', 'branch10'] instead of ['branch1', 'branch10', 'branch2']." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_commit\_comments List a commit's comments **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `commit` | string | Yes | — | The commit's SHA1. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commit": { "type": "string", "description": "The commit's SHA1." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." } }, "required": [ "PCID", "commit", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_commit\_statuses List commit statuses for a commit **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `commit` | string | Yes | — | The commit's SHA1. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `refname` | string | No | — | If specified, only return commit status objects that were either created without a refname, or were created with the specified refname | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. Defaults to `created_on`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "commit": { "type": "string", "description": "The commit's SHA1." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "refname": { "type": "string", "description": "If specified, only return commit status objects that were either created without a refname, or were created with the specified refname" }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). Defaults to `created_on`." } }, "required": [ "PCID", "commit", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_commits List commits **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_refs List branches and tags **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. The `name` field is handled specially for refs in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return \['1.1', '1.2', '1.10'] instead of \['1.1', '1.10', '1.2']. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name` field is handled specially for refs in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return ['1.1', '1.2', '1.10'] instead of ['1.1', '1.10', '1.2']." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_repositories List repositories in a workspace **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `role` | string | No | — | Filters the result based on the authenticated user's role on each repository. \* **member**: returns repositories to which the user has explicit read access \* **contributor**: returns repositories to which the user has explicit write access \* **admin**: returns repositories to which the user has explicit administrator access \* **owner**: returns all repositories owned by the current user | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "role": { "type": "string", "description": "Filters the result based on the authenticated user's role on each repository. * **member**: returns repositories to which the user has explicit read access * **contributor**: returns repositories to which the user has explicit write access * **admin**: returns repositories to which the user has explicit administrator access * **owner**: returns all repositories owned by the current user", "enum": [ "admin", "contributor", "member", "owner" ] }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." } }, "required": [ "PCID", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_repository\_forks List repository forks **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `role` | string | No | — | Filters the result based on the authenticated user's role on each repository. \* **member**: returns repositories to which the user has explicit read access \* **contributor**: returns repositories to which the user has explicit write access \* **admin**: returns repositories to which the user has explicit administrator access \* **owner**: returns all repositories owned by the current user | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "role": { "type": "string", "description": "Filters the result based on the authenticated user's role on each repository. * **member**: returns repositories to which the user has explicit read access * **contributor**: returns repositories to which the user has explicit write access * **admin**: returns repositories to which the user has explicit administrator access * **owner**: returns all repositories owned by the current user", "enum": [ "admin", "contributor", "member", "owner" ] }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_repository\_watchers List repositories watchers **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_tags List tags **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. The `name` field is handled specially for tags in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return \['1.1', '1.2', '1.10'] instead of \['1.1', '1.10', '1.2']. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name` field is handled specially for tags in that, if specified as the sort field, it uses a natural sort order instead of the default lexicographical sort order. For example, it will return ['1.1', '1.2', '1.10'] instead of ['1.1', '1.10', '1.2']." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_list\_webhooks List webhooks for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_update\_repository Update a repository **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `created_on` | string | No | — | Created On | | `description` | string | No | — | The description value | | `fork_policy` | string | No | — | Controls the rules for forking this repository. \* **allow\_forks**: unrestricted forking \* **no\_public\_forks**: restrict forking to private forks (forks cannot be made public later) \* **no\_forks**: deny all forking | | `full_name` | string | No | — | 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. | | `has_issues` | boolean | No | — | 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` | boolean | No | — | The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com. | | `is_private` | boolean | No | — | Is Private | | `language` | string | No | — | The language value | | `links` | object | No | — | The links value | | `mainbranch` | object | No | — | The mainbranch value | | `name` | string | No | — | The name value | | `owner` | object | No | — | The owner value | | `parent` | object | No | — | Circular schema reference: #/components/schemas/repository | | `project` | object | No | — | The project value | | `scm` | string | No | — | The scm value | | `size` | integer | No | — | The size value | | `type` | string | No | — | The type value | | `updated_on` | string | No | — | Updated On | | `uuid` | string | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "created_on": { "type": "string", "description": "Created On" }, "description": { "type": "string", "description": "The description value" }, "fork_policy": { "type": "string", "description": "Controls the rules for forking this repository. * **allow_forks**: unrestricted forking * **no_public_forks**: restrict forking to private forks (forks cannot be made public later) * **no_forks**: deny all forking", "enum": [ "allow_forks", "no_public_forks", "no_forks" ] }, "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." }, "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." }, "is_private": { "type": "boolean", "description": "Is Private" }, "language": { "type": "string", "description": "The language value" }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "avatar": { "type": "object", "description": "A link to a resource related to this object." }, "pullrequests": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "forks": { "type": "object", "description": "A link to a resource related to this object." }, "watchers": { "type": "object", "description": "A link to a resource related to this object." }, "downloads": { "type": "object", "description": "A link to a resource related to this object." }, "clone": { "type": "array", "items": { "type": "object" }, "description": "The clone value" }, "hooks": { "type": "object", "description": "A link to a resource related to this object." } } }, "mainbranch": { "description": "The mainbranch value" }, "name": { "type": "string", "description": "The name value" }, "owner": { "description": "The owner value" }, "parent": { "type": "object", "description": "Circular schema reference: #/components/schemas/repository" }, "project": { "description": "The project value" }, "scm": { "type": "string", "description": "The scm value", "enum": [ "git" ] }, "size": { "type": "integer", "description": "The size value" }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "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." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_repos\_update\_webhook Update a webhook for a repository **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `uid` | string | Yes | — | Installed webhook's ID | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `active` | boolean | No | — | The active value | | `created_at` | string | No | — | Created At | | `description` | string | No | — | A user-defined description of the webhook. | | `events` | string\[] | No | — | The events this webhook is subscribed to. | | `secret` | string | No | — | 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. | | `secret_set` | boolean | No | — | 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. | | `subject` | object | No | — | 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`. | | `subject_type` | string | No | — | The type of entity. Set to either `repository` or `workspace` based on where the subscription is defined. | | `type` | string | Yes | — | The type value | | `url` | string | No | — | The URL events get delivered to. | | `uuid` | string | No | — | The webhook's id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "uid": { "type": "string", "description": "Installed webhook's ID" }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "active": { "type": "boolean", "description": "The active value" }, "created_at": { "type": "string", "description": "Created At" }, "description": { "type": "string", "description": "A user-defined description of the webhook." }, "events": { "type": "array", "items": { "type": "string", "enum": [ "issue:comment_created", "issue:created", "issue:updated", "pipeline:span_created", "project:updated", "pullrequest:approved", "pullrequest:changes_request_created", "pullrequest:changes_request_removed", "pullrequest:comment_created", "pullrequest:comment_deleted", "pullrequest:comment_reopened", "pullrequest:comment_resolved", "pullrequest:comment_updated", "pullrequest:created", "pullrequest:fulfilled", "pullrequest:push", "pullrequest:rejected", "pullrequest:unapproved", "pullrequest:updated", "repo:commit_comment_created", "repo:commit_status_created", "repo:commit_status_updated", "repo:created", "repo:deleted", "repo:fork", "repo:imported", "repo:push", "repo:transfer", "repo:updated" ] }, "description": "The events this webhook is subscribed to." }, "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." }, "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." }, "subject": { "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", "description": "The type value" } }, "required": [ "type" ] }, "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" ] }, "type": { "type": "string", "description": "The type value" }, "url": { "type": "string", "description": "The URL events get delivered to." }, "uuid": { "type": "string", "description": "The webhook's id" } }, "required": [ "PCID", "repo_slug", "uid", "workspace", "type" ] } ```