Go API client for openapi

Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 2.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://support.atlassian.com/bitbucket-cloud/

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./openapi"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.bitbucket.org/2.0

Class	Method	HTTP request	Description
AddonApi	AddonDelete	Delete /addon
AddonApi	AddonLinkersGet	Get /addon/linkers
AddonApi	AddonLinkersLinkerKeyGet	Get /addon/linkers/{linker_key}
AddonApi	AddonLinkersLinkerKeyValuesDelete	Delete /addon/linkers/{linker_key}/values
AddonApi	AddonLinkersLinkerKeyValuesGet	Get /addon/linkers/{linker_key}/values
AddonApi	AddonLinkersLinkerKeyValuesPost	Post /addon/linkers/{linker_key}/values
AddonApi	AddonLinkersLinkerKeyValuesPut	Put /addon/linkers/{linker_key}/values
AddonApi	AddonLinkersLinkerKeyValuesValueIdDelete	Delete /addon/linkers/{linker_key}/values/{value_id}
AddonApi	AddonLinkersLinkerKeyValuesValueIdGet	Get /addon/linkers/{linker_key}/values/{value_id}
AddonApi	AddonPut	Put /addon
BranchRestrictionsApi	RepositoriesWorkspaceRepoSlugBranchRestrictionsGet	Get /repositories/{workspace}/{repo_slug}/branch-restrictions
BranchRestrictionsApi	RepositoriesWorkspaceRepoSlugBranchRestrictionsIdDelete	Delete /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}
BranchRestrictionsApi	RepositoriesWorkspaceRepoSlugBranchRestrictionsIdGet	Get /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}
BranchRestrictionsApi	RepositoriesWorkspaceRepoSlugBranchRestrictionsIdPut	Put /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}
BranchRestrictionsApi	RepositoriesWorkspaceRepoSlugBranchRestrictionsPost	Post /repositories/{workspace}/{repo_slug}/branch-restrictions
BranchingModelApi	RepositoriesWorkspaceRepoSlugBranchingModelGet	Get /repositories/{workspace}/{repo_slug}/branching-model
BranchingModelApi	RepositoriesWorkspaceRepoSlugBranchingModelSettingsGet	Get /repositories/{workspace}/{repo_slug}/branching-model/settings
BranchingModelApi	RepositoriesWorkspaceRepoSlugBranchingModelSettingsPut	Put /repositories/{workspace}/{repo_slug}/branching-model/settings
CommitStatusesApi	RepositoriesWorkspaceRepoSlugCommitCommitStatusesBuildKeyGet	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}
CommitStatusesApi	RepositoriesWorkspaceRepoSlugCommitCommitStatusesBuildKeyPut	Put /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}
CommitStatusesApi	RepositoriesWorkspaceRepoSlugCommitCommitStatusesBuildPost	Post /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build
CommitStatusesApi	RepositoriesWorkspaceRepoSlugCommitCommitStatusesGet	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses
CommitStatusesApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdStatusesGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses
CommitsApi	BulkCreateOrUpdateAnnotations	Post /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations
CommitsApi	CreateOrUpdateAnnotation	Put /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}
CommitsApi	CreateOrUpdateReport	Put /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}
CommitsApi	DeleteAnnotation	Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}
CommitsApi	DeleteReport	Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}
CommitsApi	GetAnnotation	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}
CommitsApi	GetAnnotationsForReport	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations
CommitsApi	GetReport	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}
CommitsApi	GetReportsForCommit	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports
CommitsApi	RepositoriesWorkspaceRepoSlugCommitCommitApproveDelete	Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/approve
CommitsApi	RepositoriesWorkspaceRepoSlugCommitCommitApprovePost	Post /repositories/{workspace}/{repo_slug}/commit/{commit}/approve
CommitsApi	RepositoriesWorkspaceRepoSlugCommitCommitCommentsCommentIdGet	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id}
CommitsApi	RepositoriesWorkspaceRepoSlugCommitCommitCommentsGet	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/comments
CommitsApi	RepositoriesWorkspaceRepoSlugCommitCommitCommentsPost	Post /repositories/{workspace}/{repo_slug}/commit/{commit}/comments
CommitsApi	RepositoriesWorkspaceRepoSlugCommitCommitGet	Get /repositories/{workspace}/{repo_slug}/commit/{commit}
CommitsApi	RepositoriesWorkspaceRepoSlugCommitsGet	Get /repositories/{workspace}/{repo_slug}/commits
CommitsApi	RepositoriesWorkspaceRepoSlugCommitsPost	Post /repositories/{workspace}/{repo_slug}/commits
CommitsApi	RepositoriesWorkspaceRepoSlugCommitsRevisionGet	Get /repositories/{workspace}/{repo_slug}/commits/{revision}
CommitsApi	RepositoriesWorkspaceRepoSlugCommitsRevisionPost	Post /repositories/{workspace}/{repo_slug}/commits/{revision}
CommitsApi	RepositoriesWorkspaceRepoSlugDiffSpecGet	Get /repositories/{workspace}/{repo_slug}/diff/{spec}
CommitsApi	RepositoriesWorkspaceRepoSlugDiffstatSpecGet	Get /repositories/{workspace}/{repo_slug}/diffstat/{spec}
CommitsApi	RepositoriesWorkspaceRepoSlugMergeBaseRevspecGet	Get /repositories/{workspace}/{repo_slug}/merge-base/{revspec}
CommitsApi	RepositoriesWorkspaceRepoSlugPatchSpecGet	Get /repositories/{workspace}/{repo_slug}/patch/{spec}
DefaultApi	RepositoriesWorkspaceRepoSlugPipelinesPipelineUuidStepsStepUuidLogsLogUuidGet	Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid}
DefaultApi	RepositoriesWorkspaceRepoSlugPipelinesPipelineUuidStepsStepUuidTestReportsGet	Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports
DefaultApi	RepositoriesWorkspaceRepoSlugPipelinesPipelineUuidStepsStepUuidTestReportsTestCasesGet	Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases
DefaultApi	RepositoriesWorkspaceRepoSlugPipelinesPipelineUuidStepsStepUuidTestReportsTestCasesTestCaseUuidTestCaseReasonsGet	Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons
DefaultApi	WorkspacesWorkspacePipelinesConfigIdentityOidcKeysJsonGet	Get /workspaces/{workspace}/pipelines-config/identity/oidc/keys.json
DefaultApi	WorkspacesWorkspacePipelinesConfigIdentityOidcWellKnownOpenidConfigurationGet	Get /workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configuration
DeploymentsApi	CreateEnvironment	Post /repositories/{workspace}/{repo_slug}/environments/
DeploymentsApi	DeleteEnvironmentForRepository	Delete /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}
DeploymentsApi	GetDeploymentForRepository	Get /repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid}
DeploymentsApi	GetDeploymentsForRepository	Get /repositories/{workspace}/{repo_slug}/deployments/
DeploymentsApi	GetEnvironmentForRepository	Get /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}
DeploymentsApi	GetEnvironmentsForRepository	Get /repositories/{workspace}/{repo_slug}/environments/
DeploymentsApi	RepositoriesWorkspaceRepoSlugDeployKeysGet	Get /repositories/{workspace}/{repo_slug}/deploy-keys
DeploymentsApi	RepositoriesWorkspaceRepoSlugDeployKeysKeyIdDelete	Delete /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}
DeploymentsApi	RepositoriesWorkspaceRepoSlugDeployKeysKeyIdGet	Get /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}
DeploymentsApi	RepositoriesWorkspaceRepoSlugDeployKeysKeyIdPut	Put /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}
DeploymentsApi	RepositoriesWorkspaceRepoSlugDeployKeysPost	Post /repositories/{workspace}/{repo_slug}/deploy-keys
DeploymentsApi	UpdateEnvironmentForRepository	Post /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/changes/
DownloadsApi	RepositoriesWorkspaceRepoSlugDownloadsFilenameDelete	Delete /repositories/{workspace}/{repo_slug}/downloads/{filename}
DownloadsApi	RepositoriesWorkspaceRepoSlugDownloadsFilenameGet	Get /repositories/{workspace}/{repo_slug}/downloads/{filename}
DownloadsApi	RepositoriesWorkspaceRepoSlugDownloadsGet	Get /repositories/{workspace}/{repo_slug}/downloads
DownloadsApi	RepositoriesWorkspaceRepoSlugDownloadsPost	Post /repositories/{workspace}/{repo_slug}/downloads
IssueTrackerApi	RepositoriesWorkspaceRepoSlugComponentsComponentIdGet	Get /repositories/{workspace}/{repo_slug}/components/{component_id}
IssueTrackerApi	RepositoriesWorkspaceRepoSlugComponentsGet	Get /repositories/{workspace}/{repo_slug}/components
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesExportPost	Post /repositories/{workspace}/{repo_slug}/issues/export
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesExportRepoNameIssuesTaskIdZipGet	Get /repositories/{workspace}/{repo_slug}/issues/export/{repo_name}-issues-{task_id}.zip
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesGet	Get /repositories/{workspace}/{repo_slug}/issues
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesImportGet	Get /repositories/{workspace}/{repo_slug}/issues/import
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesImportPost	Post /repositories/{workspace}/{repo_slug}/issues/import
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsGet	Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPathDelete	Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path}
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPathGet	Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path}
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPost	Post /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdChangesChangeIdGet	Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes/{change_id}
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdChangesGet	Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdChangesPost	Post /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdDelete	Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id}
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdGet	Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id}
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdPut	Put /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id}
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsGet	Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsPost	Post /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdDelete	Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdGet	Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdPut	Put /repositories/{workspace}/{repo_slug}/issues/{issue_id}
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdVoteDelete	Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdVoteGet	Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdVotePut	Put /repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdWatchDelete	Delete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdWatchGet	Get /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesIssueIdWatchPut	Put /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch
IssueTrackerApi	RepositoriesWorkspaceRepoSlugIssuesPost	Post /repositories/{workspace}/{repo_slug}/issues
IssueTrackerApi	RepositoriesWorkspaceRepoSlugMilestonesGet	Get /repositories/{workspace}/{repo_slug}/milestones
IssueTrackerApi	RepositoriesWorkspaceRepoSlugMilestonesMilestoneIdGet	Get /repositories/{workspace}/{repo_slug}/milestones/{milestone_id}
IssueTrackerApi	RepositoriesWorkspaceRepoSlugVersionsGet	Get /repositories/{workspace}/{repo_slug}/versions
IssueTrackerApi	RepositoriesWorkspaceRepoSlugVersionsVersionIdGet	Get /repositories/{workspace}/{repo_slug}/versions/{version_id}
PipelinesApi	CreateDeploymentVariable	Post /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables
PipelinesApi	CreatePipelineForRepository	Post /repositories/{workspace}/{repo_slug}/pipelines/
PipelinesApi	CreatePipelineVariableForTeam	Post /teams/{username}/pipelines_config/variables/
PipelinesApi	CreatePipelineVariableForUser	Post /users/{selected_user}/pipelines_config/variables/
PipelinesApi	CreatePipelineVariableForWorkspace	Post /workspaces/{workspace}/pipelines-config/variables
PipelinesApi	CreateRepositoryPipelineKnownHost	Post /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/
PipelinesApi	CreateRepositoryPipelineSchedule	Post /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/
PipelinesApi	CreateRepositoryPipelineVariable	Post /repositories/{workspace}/{repo_slug}/pipelines_config/variables/
PipelinesApi	DeleteDeploymentVariable	Delete /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}
PipelinesApi	DeletePipelineVariableForTeam	Delete /teams/{username}/pipelines_config/variables/{variable_uuid}
PipelinesApi	DeletePipelineVariableForUser	Delete /users/{selected_user}/pipelines_config/variables/{variable_uuid}
PipelinesApi	DeletePipelineVariableForWorkspace	Delete /workspaces/{workspace}/pipelines-config/variables/{variable_uuid}
PipelinesApi	DeleteRepositoryPipelineCache	Delete /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}
PipelinesApi	DeleteRepositoryPipelineKeyPair	Delete /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair
PipelinesApi	DeleteRepositoryPipelineKnownHost	Delete /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}
PipelinesApi	DeleteRepositoryPipelineSchedule	Delete /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}
PipelinesApi	DeleteRepositoryPipelineVariable	Delete /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}
PipelinesApi	GetDeploymentVariables	Get /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables
PipelinesApi	GetPipelineForRepository	Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}
PipelinesApi	GetPipelineStepForRepository	Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}
PipelinesApi	GetPipelineStepLogForRepository	Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log
PipelinesApi	GetPipelineStepsForRepository	Get /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/
PipelinesApi	GetPipelineVariableForTeam	Get /teams/{username}/pipelines_config/variables/{variable_uuid}
PipelinesApi	GetPipelineVariableForUser	Get /users/{selected_user}/pipelines_config/variables/{variable_uuid}
PipelinesApi	GetPipelineVariableForWorkspace	Get /workspaces/{workspace}/pipelines-config/variables/{variable_uuid}
PipelinesApi	GetPipelineVariablesForTeam	Get /teams/{username}/pipelines_config/variables/
PipelinesApi	GetPipelineVariablesForUser	Get /users/{selected_user}/pipelines_config/variables/
PipelinesApi	GetPipelineVariablesForWorkspace	Get /workspaces/{workspace}/pipelines-config/variables
PipelinesApi	GetPipelinesForRepository	Get /repositories/{workspace}/{repo_slug}/pipelines/
PipelinesApi	GetRepositoryPipelineCacheContentURI	Get /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri
PipelinesApi	GetRepositoryPipelineCaches	Get /repositories/{workspace}/{repo_slug}/pipelines-config/caches/
PipelinesApi	GetRepositoryPipelineConfig	Get /repositories/{workspace}/{repo_slug}/pipelines_config
PipelinesApi	GetRepositoryPipelineKnownHost	Get /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}
PipelinesApi	GetRepositoryPipelineKnownHosts	Get /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/
PipelinesApi	GetRepositoryPipelineSchedule	Get /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}
PipelinesApi	GetRepositoryPipelineScheduleExecutions	Get /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions/
PipelinesApi	GetRepositoryPipelineSchedules	Get /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/
PipelinesApi	GetRepositoryPipelineSshKeyPair	Get /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair
PipelinesApi	GetRepositoryPipelineVariable	Get /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}
PipelinesApi	GetRepositoryPipelineVariables	Get /repositories/{workspace}/{repo_slug}/pipelines_config/variables/
PipelinesApi	StopPipeline	Post /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline
PipelinesApi	UpdateDeploymentVariable	Put /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}
PipelinesApi	UpdatePipelineVariableForTeam	Put /teams/{username}/pipelines_config/variables/{variable_uuid}
PipelinesApi	UpdatePipelineVariableForUser	Put /users/{selected_user}/pipelines_config/variables/{variable_uuid}
PipelinesApi	UpdatePipelineVariableForWorkspace	Put /workspaces/{workspace}/pipelines-config/variables/{variable_uuid}
PipelinesApi	UpdateRepositoryBuildNumber	Put /repositories/{workspace}/{repo_slug}/pipelines_config/build_number
PipelinesApi	UpdateRepositoryPipelineConfig	Put /repositories/{workspace}/{repo_slug}/pipelines_config
PipelinesApi	UpdateRepositoryPipelineKeyPair	Put /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair
PipelinesApi	UpdateRepositoryPipelineKnownHost	Put /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}
PipelinesApi	UpdateRepositoryPipelineSchedule	Put /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}
PipelinesApi	UpdateRepositoryPipelineVariable	Put /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}
ProjectsApi	TeamsUsernameProjectsGet	Get /teams/{username}/projects/
ProjectsApi	TeamsUsernameProjectsPost	Post /teams/{username}/projects/
ProjectsApi	TeamsUsernameProjectsProjectKeyDelete	Delete /teams/{username}/projects/{project_key}
ProjectsApi	TeamsUsernameProjectsProjectKeyGet	Get /teams/{username}/projects/{project_key}
ProjectsApi	TeamsUsernameProjectsProjectKeyPut	Put /teams/{username}/projects/{project_key}
ProjectsApi	WorkspacesWorkspaceProjectsPost	Post /workspaces/{workspace}/projects
ProjectsApi	WorkspacesWorkspaceProjectsProjectKeyDelete	Delete /workspaces/{workspace}/projects/{project_key}
ProjectsApi	WorkspacesWorkspaceProjectsProjectKeyGet	Get /workspaces/{workspace}/projects/{project_key}
ProjectsApi	WorkspacesWorkspaceProjectsProjectKeyPut	Put /workspaces/{workspace}/projects/{project_key}
PropertiesApi	DeleteCommitHostedPropertyValue	Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}
PropertiesApi	DeletePullRequestHostedPropertyValue	Delete /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}
PropertiesApi	DeleteRepositoryHostedPropertyValue	Delete /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}
PropertiesApi	DeleteUserHostedPropertyValue	Delete /users/{selected_user}/properties/{app_key}/{property_name}
PropertiesApi	GetCommitHostedPropertyValue	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}
PropertiesApi	GetPullRequestHostedPropertyValue	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}
PropertiesApi	GetRepositoryHostedPropertyValue	Get /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}
PropertiesApi	RetrieveUserHostedPropertyValue	Get /users/{selected_user}/properties/{app_key}/{property_name}
PropertiesApi	UpdateCommitHostedPropertyValue	Put /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}
PropertiesApi	UpdatePullRequestHostedPropertyValue	Put /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}
PropertiesApi	UpdateRepositoryHostedPropertyValue	Put /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}
PropertiesApi	UpdateUserHostedPropertyValue	Put /users/{selected_user}/properties/{app_key}/{property_name}
PullrequestsApi	GetPullrequestsForCommit	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests	Returns a paginated list of all pull requests as part of which this commit was reviewed. Pull Request Commit Links app must be installed first before using this API; installation automatically occurs when 'Go to pull request' is clicked from the web interface for a commit's details.
PullrequestsApi	PullrequestsSelectedUserGet	Get /pullrequests/{selected_user}
PullrequestsApi	RepositoriesWorkspaceRepoSlugDefaultReviewersGet	Get /repositories/{workspace}/{repo_slug}/default-reviewers
PullrequestsApi	RepositoriesWorkspaceRepoSlugDefaultReviewersTargetUsernameDelete	Delete /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}
PullrequestsApi	RepositoriesWorkspaceRepoSlugDefaultReviewersTargetUsernameGet	Get /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}
PullrequestsApi	RepositoriesWorkspaceRepoSlugDefaultReviewersTargetUsernamePut	Put /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsActivityGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/activity
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsGet	Get /repositories/{workspace}/{repo_slug}/pullrequests
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPost	Post /repositories/{workspace}/{repo_slug}/pullrequests
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdActivityGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdApproveDelete	Delete /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdApprovePost	Post /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsCommentIdDelete	Delete /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsCommentIdGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsCommentIdPut	Put /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsPost	Post /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommitsGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commits
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdDeclinePost	Post /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/decline
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdDiffGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diff
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdDiffstatGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdMergePost	Post /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdMergeTaskStatusTaskIdGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge/task-status/{task_id}
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdPatchGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patch
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdPut	Put /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdRequestChangesDelete	Delete /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdRequestChangesPost	Post /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes
PullrequestsApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdStatusesGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses
RefsApi	RepositoriesWorkspaceRepoSlugRefsBranchesGet	Get /repositories/{workspace}/{repo_slug}/refs/branches
RefsApi	RepositoriesWorkspaceRepoSlugRefsBranchesNameDelete	Delete /repositories/{workspace}/{repo_slug}/refs/branches/{name}
RefsApi	RepositoriesWorkspaceRepoSlugRefsBranchesNameGet	Get /repositories/{workspace}/{repo_slug}/refs/branches/{name}
RefsApi	RepositoriesWorkspaceRepoSlugRefsBranchesPost	Post /repositories/{workspace}/{repo_slug}/refs/branches
RefsApi	RepositoriesWorkspaceRepoSlugRefsGet	Get /repositories/{workspace}/{repo_slug}/refs
RefsApi	RepositoriesWorkspaceRepoSlugRefsTagsGet	Get /repositories/{workspace}/{repo_slug}/refs/tags
RefsApi	RepositoriesWorkspaceRepoSlugRefsTagsNameDelete	Delete /repositories/{workspace}/{repo_slug}/refs/tags/{name}
RefsApi	RepositoriesWorkspaceRepoSlugRefsTagsNameGet	Get /repositories/{workspace}/{repo_slug}/refs/tags/{name}
RefsApi	RepositoriesWorkspaceRepoSlugRefsTagsPost	Post /repositories/{workspace}/{repo_slug}/refs/tags
ReportsApi	BulkCreateOrUpdateAnnotations	Post /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations
ReportsApi	CreateOrUpdateAnnotation	Put /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}
ReportsApi	CreateOrUpdateReport	Put /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}
ReportsApi	DeleteAnnotation	Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}
ReportsApi	DeleteReport	Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}
ReportsApi	GetAnnotation	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}
ReportsApi	GetAnnotationsForReport	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations
ReportsApi	GetReport	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}
ReportsApi	GetReportsForCommit	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/reports
RepositoriesApi	RepositoriesGet	Get /repositories
RepositoriesApi	RepositoriesWorkspaceGet	Get /repositories/{workspace}
RepositoriesApi	RepositoriesWorkspaceRepoSlugCommitCommitStatusesBuildKeyGet	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}
RepositoriesApi	RepositoriesWorkspaceRepoSlugCommitCommitStatusesBuildKeyPut	Put /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}
RepositoriesApi	RepositoriesWorkspaceRepoSlugCommitCommitStatusesBuildPost	Post /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build
RepositoriesApi	RepositoriesWorkspaceRepoSlugCommitCommitStatusesGet	Get /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses
RepositoriesApi	RepositoriesWorkspaceRepoSlugDelete	Delete /repositories/{workspace}/{repo_slug}
RepositoriesApi	RepositoriesWorkspaceRepoSlugFilehistoryCommitPathGet	Get /repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path}
RepositoriesApi	RepositoriesWorkspaceRepoSlugForksGet	Get /repositories/{workspace}/{repo_slug}/forks
RepositoriesApi	RepositoriesWorkspaceRepoSlugForksPost	Post /repositories/{workspace}/{repo_slug}/forks
RepositoriesApi	RepositoriesWorkspaceRepoSlugGet	Get /repositories/{workspace}/{repo_slug}
RepositoriesApi	RepositoriesWorkspaceRepoSlugHooksGet	Get /repositories/{workspace}/{repo_slug}/hooks
RepositoriesApi	RepositoriesWorkspaceRepoSlugHooksPost	Post /repositories/{workspace}/{repo_slug}/hooks
RepositoriesApi	RepositoriesWorkspaceRepoSlugHooksUidDelete	Delete /repositories/{workspace}/{repo_slug}/hooks/{uid}
RepositoriesApi	RepositoriesWorkspaceRepoSlugHooksUidGet	Get /repositories/{workspace}/{repo_slug}/hooks/{uid}
RepositoriesApi	RepositoriesWorkspaceRepoSlugHooksUidPut	Put /repositories/{workspace}/{repo_slug}/hooks/{uid}
RepositoriesApi	RepositoriesWorkspaceRepoSlugPost	Post /repositories/{workspace}/{repo_slug}
RepositoriesApi	RepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdStatusesGet	Get /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses
RepositoriesApi	RepositoriesWorkspaceRepoSlugPut	Put /repositories/{workspace}/{repo_slug}
RepositoriesApi	RepositoriesWorkspaceRepoSlugSrcCommitPathGet	Get /repositories/{workspace}/{repo_slug}/src/{commit}/{path}
RepositoriesApi	RepositoriesWorkspaceRepoSlugSrcGet	Get /repositories/{workspace}/{repo_slug}/src
RepositoriesApi	RepositoriesWorkspaceRepoSlugSrcPost	Post /repositories/{workspace}/{repo_slug}/src
RepositoriesApi	RepositoriesWorkspaceRepoSlugWatchersGet	Get /repositories/{workspace}/{repo_slug}/watchers
RepositoriesApi	UserPermissionsRepositoriesGet	Get /user/permissions/repositories
SearchApi	SearchAccount	Get /teams/{username}/search/code	Search for code in the repositories of the specified team. Searching across all repositories: ``` curl 'https://api.bitbucket.org/2.0/teams/team_name/search/code?search_query=foo' { "size": 1, "page": 1, "pagelen": 10, "query_substituted": false, "values": [ { "type": "code_search_result", "content_match_count": 2, "content_matches": [ { "lines": [ { "line": 2, "segments": [] }, { "line": 3, "segments": [ { "text": "def " }, { "text": "foo", "match": true }, { "text": "():" } ] }, { "line": 4, "segments": [ { "text": " print(\"snek\")" } ] }, { "line": 5, "segments": [] } ] } ], "path_matches": [ { "text": "src/" }, { "text": "foo", "match": true }, { "text": ".py" } ], "file": { "path": "src/foo.py", "type": "commit_file", "links": { "self": { "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py" } } } } ] } ``` Note that searches can match in the file's text (`content_matches`), the path (`path_matches`), or both as in the example above. You can use the same syntax for the search query as in the UI, e.g. to only search within a specific repository: ``` curl 'https://api.bitbucket.org/2.0/teams/team_name/search/code?search_query=foo+repo:demo' # results from the "demo" repository ``` Similar to other APIs, you can request more fields using a `fields` query parameter. E.g. to get some more information about the repository of matched files (the `%2B` is a URL-encoded `+`): ``` curl 'https://api.bitbucket.org/2.0/teams/team_name/search/code'\\ '?search_query=foo&fields=%2Bvalues.file.commit.repository' { "size": 1, "page": 1, "pagelen": 10, "query_substituted": false, "values": [ { "type": "code_search_result", "content_match_count": 1, "content_matches": [...], "path_matches": [...], "file": { "commit": { "type": "commit", "hash": "ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b", "links": { "self": { "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo/commit/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b" }, "html": { "href": "https://bitbucket.org/my-workspace/demo/commits/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b" } }, "repository": { "name": "demo", "type": "repository", "full_name": "my-workspace/demo", "links": { "self": { "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo" }, "html": { "href": "https://bitbucket.org/my-workspace/demo" }, "avatar": { "href": "https://bytebucket.org/ravatar/%7B850e1749-781a-4115-9316-df39d0600e7a%7D?ts=default" } }, "uuid": "{850e1749-781a-4115-9316-df39d0600e7a}" } }, "type": "commit_file", "links": { "self": { "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py" } }, "path": "src/foo.py" } } ] } ``` Try `fields=%2Bvalues....` to get an idea what's possible.
SearchApi	SearchAccount_0	Get /users/{selected_user}/search/code	Search for code in the repositories of the specified user. Searching across all repositories: ``` curl 'https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/search/code?search_query=foo' { "size": 1, "page": 1, "pagelen": 10, "query_substituted": false, "values": [ { "type": "code_search_result", "content_match_count": 2, "content_matches": [ { "lines": [ { "line": 2, "segments": [] }, { "line": 3, "segments": [ { "text": "def " }, { "text": "foo", "match": true }, { "text": "():" } ] }, { "line": 4, "segments": [ { "text": " print(\"snek\")" } ] }, { "line": 5, "segments": [] } ] } ], "path_matches": [ { "text": "src/" }, { "text": "foo", "match": true }, { "text": ".py" } ], "file": { "path": "src/foo.py", "type": "commit_file", "links": { "self": { "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py" } } } } ] } ``` Note that searches can match in the file's text (`content_matches`), the path (`path_matches`), or both as in the example above. You can use the same syntax for the search query as in the UI, e.g. to only search within a specific repository: ``` curl 'https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/search/code?search_query=foo+repo:demo' # results from the "demo" repository ``` Similar to other APIs, you can request more fields using a `fields` query parameter. E.g. to get some more information about the repository of matched files (the `%2B` is a URL-encoded `+`): ``` curl 'https://api.bitbucket.org/2.0/users/{ed08f5e1-605b-4f4a-aee4-6c97628a673e}/search/code'\\ '?search_query=foo&fields=%2Bvalues.file.commit.repository' { "size": 1, "page": 1, "pagelen": 10, "query_substituted": false, "values": [ { "type": "code_search_result", "content_match_count": 1, "content_matches": [...], "path_matches": [...], "file": { "commit": { "type": "commit", "hash": "ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b", "links": { "self": { "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo/commit/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b" }, "html": { "href": "https://bitbucket.org/my-workspace/demo/commits/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b" } }, "repository": { "name": "demo", "type": "repository", "full_name": "my-workspace/demo", "links": { "self": { "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo" }, "html": { "href": "https://bitbucket.org/my-workspace/demo" }, "avatar": { "href": "https://bytebucket.org/ravatar/%7B850e1749-781a-4115-9316-df39d0600e7a%7D?ts=default" } }, "uuid": "{850e1749-781a-4115-9316-df39d0600e7a}" } }, "type": "commit_file", "links": { "self": { "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py" } }, "path": "src/foo.py" } } ] } ``` Try `fields=%2Bvalues....` to get an idea what's possible.
SearchApi	SearchAccount_1	Get /workspaces/{workspace}/search/code	Search for code in the repositories of the specified workspace. Searching across all repositories: ``` curl 'https://api.bitbucket.org/2.0/workspaces/workspace_slug_or_uuid/search/code?search_query=foo' { "size": 1, "page": 1, "pagelen": 10, "query_substituted": false, "values": [ { "type": "code_search_result", "content_match_count": 2, "content_matches": [ { "lines": [ { "line": 2, "segments": [] }, { "line": 3, "segments": [ { "text": "def " }, { "text": "foo", "match": true }, { "text": "():" } ] }, { "line": 4, "segments": [ { "text": " print(\"snek\")" } ] }, { "line": 5, "segments": [] } ] } ], "path_matches": [ { "text": "src/" }, { "text": "foo", "match": true }, { "text": ".py" } ], "file": { "path": "src/foo.py", "type": "commit_file", "links": { "self": { "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py" } } } } ] } ``` Note that searches can match in the file's text (`content_matches`), the path (`path_matches`), or both as in the example above. You can use the same syntax for the search query as in the UI, e.g. to only search within a specific repository: ``` curl 'https://api.bitbucket.org/2.0/workspaces/my-workspace/search/code?search_query=foo+repo:demo' # results from the "demo" repository ``` Similar to other APIs, you can request more fields using a `fields` query parameter. E.g. to get some more information about the repository of matched files (the `%2B` is a URL-encoded `+`): ``` curl 'https://api.bitbucket.org/2.0/workspaces/my-workspace/search/code'\\ '?search_query=foo&fields=%2Bvalues.file.commit.repository' { "size": 1, "page": 1, "pagelen": 10, "query_substituted": false, "values": [ { "type": "code_search_result", "content_match_count": 1, "content_matches": [...], "path_matches": [...], "file": { "commit": { "type": "commit", "hash": "ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b", "links": { "self": { "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo/commit/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b" }, "html": { "href": "https://bitbucket.org/my-workspace/demo/commits/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b" } }, "repository": { "name": "demo", "type": "repository", "full_name": "my-workspace/demo", "links": { "self": { "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo" }, "html": { "href": "https://bitbucket.org/my-workspace/demo" }, "avatar": { "href": "https://bytebucket.org/ravatar/%7B850e1749-781a-4115-9316-df39d0600e7a%7D?ts=default" } }, "uuid": "{850e1749-781a-4115-9316-df39d0600e7a}" } }, "type": "commit_file", "links": { "self": { "href": "https://api.bitbucket.org/2.0/repositories/my-workspace/demo/src/ad6964b5fe2880dbd9ddcad1c89000f1dbcbc24b/src/foo.py" } }, "path": "src/foo.py" } } ] } ``` Try `fields=%2Bvalues....` to get an idea what's possible.
SnippetsApi	SnippetsGet	Get /snippets
SnippetsApi	SnippetsPost	Post /snippets
SnippetsApi	SnippetsWorkspaceEncodedIdCommentsCommentIdDelete	Delete /snippets/{workspace}/{encoded_id}/comments/{comment_id}
SnippetsApi	SnippetsWorkspaceEncodedIdCommentsCommentIdGet	Get /snippets/{workspace}/{encoded_id}/comments/{comment_id}
SnippetsApi	SnippetsWorkspaceEncodedIdCommentsCommentIdPut	Put /snippets/{workspace}/{encoded_id}/comments/{comment_id}
SnippetsApi	SnippetsWorkspaceEncodedIdCommentsGet	Get /snippets/{workspace}/{encoded_id}/comments
SnippetsApi	SnippetsWorkspaceEncodedIdCommentsPost	Post /snippets/{workspace}/{encoded_id}/comments
SnippetsApi	SnippetsWorkspaceEncodedIdCommitsGet	Get /snippets/{workspace}/{encoded_id}/commits
SnippetsApi	SnippetsWorkspaceEncodedIdCommitsRevisionGet	Get /snippets/{workspace}/{encoded_id}/commits/{revision}
SnippetsApi	SnippetsWorkspaceEncodedIdDelete	Delete /snippets/{workspace}/{encoded_id}
SnippetsApi	SnippetsWorkspaceEncodedIdFilesPathGet	Get /snippets/{workspace}/{encoded_id}/files/{path}
SnippetsApi	SnippetsWorkspaceEncodedIdGet	Get /snippets/{workspace}/{encoded_id}
SnippetsApi	SnippetsWorkspaceEncodedIdNodeIdDelete	Delete /snippets/{workspace}/{encoded_id}/{node_id}
SnippetsApi	SnippetsWorkspaceEncodedIdNodeIdFilesPathGet	Get /snippets/{workspace}/{encoded_id}/{node_id}/files/{path}
SnippetsApi	SnippetsWorkspaceEncodedIdNodeIdGet	Get /snippets/{workspace}/{encoded_id}/{node_id}
SnippetsApi	SnippetsWorkspaceEncodedIdNodeIdPut	Put /snippets/{workspace}/{encoded_id}/{node_id}
SnippetsApi	SnippetsWorkspaceEncodedIdPut	Put /snippets/{workspace}/{encoded_id}
SnippetsApi	SnippetsWorkspaceEncodedIdRevisionDiffGet	Get /snippets/{workspace}/{encoded_id}/{revision}/diff
SnippetsApi	SnippetsWorkspaceEncodedIdRevisionPatchGet	Get /snippets/{workspace}/{encoded_id}/{revision}/patch
SnippetsApi	SnippetsWorkspaceEncodedIdWatchDelete	Delete /snippets/{workspace}/{encoded_id}/watch
SnippetsApi	SnippetsWorkspaceEncodedIdWatchGet	Get /snippets/{workspace}/{encoded_id}/watch
SnippetsApi	SnippetsWorkspaceEncodedIdWatchPut	Put /snippets/{workspace}/{encoded_id}/watch
SnippetsApi	SnippetsWorkspaceEncodedIdWatchersGet	Get /snippets/{workspace}/{encoded_id}/watchers
SnippetsApi	SnippetsWorkspaceGet	Get /snippets/{workspace}
SnippetsApi	SnippetsWorkspacePost	Post /snippets/{workspace}
SourceApi	RepositoriesWorkspaceRepoSlugFilehistoryCommitPathGet	Get /repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path}
SourceApi	RepositoriesWorkspaceRepoSlugSrcCommitPathGet	Get /repositories/{workspace}/{repo_slug}/src/{commit}/{path}
SourceApi	RepositoriesWorkspaceRepoSlugSrcGet	Get /repositories/{workspace}/{repo_slug}/src
SourceApi	RepositoriesWorkspaceRepoSlugSrcPost	Post /repositories/{workspace}/{repo_slug}/src
SshApi	UsersSelectedUserSshKeysGet	Get /users/{selected_user}/ssh-keys
SshApi	UsersSelectedUserSshKeysKeyIdDelete	Delete /users/{selected_user}/ssh-keys/{key_id}
SshApi	UsersSelectedUserSshKeysKeyIdGet	Get /users/{selected_user}/ssh-keys/{key_id}
SshApi	UsersSelectedUserSshKeysKeyIdPut	Put /users/{selected_user}/ssh-keys/{key_id}
SshApi	UsersSelectedUserSshKeysPost	Post /users/{selected_user}/ssh-keys
TeamsApi	TeamsGet	Get /teams
TeamsApi	TeamsUsernameFollowersGet	Get /teams/{username}/followers
TeamsApi	TeamsUsernameFollowingGet	Get /teams/{username}/following
TeamsApi	TeamsUsernameGet	Get /teams/{username}
TeamsApi	TeamsUsernameHooksGet	Get /teams/{username}/hooks
TeamsApi	TeamsUsernameHooksPost	Post /teams/{username}/hooks
TeamsApi	TeamsUsernameHooksUidDelete	Delete /teams/{username}/hooks/{uid}
TeamsApi	TeamsUsernameHooksUidGet	Get /teams/{username}/hooks/{uid}
TeamsApi	TeamsUsernameHooksUidPut	Put /teams/{username}/hooks/{uid}
TeamsApi	TeamsUsernameMembersGet	Get /teams/{username}/members
TeamsApi	TeamsUsernamePermissionsGet	Get /teams/{username}/permissions
TeamsApi	TeamsUsernamePermissionsRepositoriesGet	Get /teams/{username}/permissions/repositories
TeamsApi	TeamsUsernamePermissionsRepositoriesRepoSlugGet	Get /teams/{username}/permissions/repositories/{repo_slug}
TeamsApi	TeamsWorkspaceRepositoriesGet	Get /teams/{workspace}/repositories
TeamsApi	UserPermissionsTeamsGet	Get /user/permissions/teams
TeamsApi	UsersWorkspaceRepositoriesGet	Get /users/{workspace}/repositories
UsersApi	TeamsWorkspaceRepositoriesGet	Get /teams/{workspace}/repositories
UsersApi	UserEmailsEmailGet	Get /user/emails/{email}
UsersApi	UserEmailsGet	Get /user/emails
UsersApi	UserGet	Get /user
UsersApi	UsersSelectedUserGet	Get /users/{selected_user}
UsersApi	UsersSelectedUserHooksGet	Get /users/{selected_user}/hooks
UsersApi	UsersSelectedUserHooksPost	Post /users/{selected_user}/hooks
UsersApi	UsersSelectedUserHooksUidDelete	Delete /users/{selected_user}/hooks/{uid}
UsersApi	UsersSelectedUserHooksUidGet	Get /users/{selected_user}/hooks/{uid}
UsersApi	UsersSelectedUserHooksUidPut	Put /users/{selected_user}/hooks/{uid}
UsersApi	UsersUsernameMembersGet	Get /users/{username}/members
UsersApi	UsersWorkspaceRepositoriesGet	Get /users/{workspace}/repositories
WebhooksApi	HookEventsGet	Get /hook_events
WebhooksApi	HookEventsSubjectTypeGet	Get /hook_events/{subject_type}
WebhooksApi	RepositoriesWorkspaceRepoSlugHooksGet	Get /repositories/{workspace}/{repo_slug}/hooks
WebhooksApi	RepositoriesWorkspaceRepoSlugHooksPost	Post /repositories/{workspace}/{repo_slug}/hooks
WebhooksApi	RepositoriesWorkspaceRepoSlugHooksUidDelete	Delete /repositories/{workspace}/{repo_slug}/hooks/{uid}
WebhooksApi	RepositoriesWorkspaceRepoSlugHooksUidGet	Get /repositories/{workspace}/{repo_slug}/hooks/{uid}
WebhooksApi	RepositoriesWorkspaceRepoSlugHooksUidPut	Put /repositories/{workspace}/{repo_slug}/hooks/{uid}
WebhooksApi	TeamsUsernameHooksGet	Get /teams/{username}/hooks
WebhooksApi	TeamsUsernameHooksPost	Post /teams/{username}/hooks
WebhooksApi	TeamsUsernameHooksUidDelete	Delete /teams/{username}/hooks/{uid}
WebhooksApi	TeamsUsernameHooksUidGet	Get /teams/{username}/hooks/{uid}
WebhooksApi	TeamsUsernameHooksUidPut	Put /teams/{username}/hooks/{uid}
WebhooksApi	UsersSelectedUserHooksGet	Get /users/{selected_user}/hooks
WebhooksApi	UsersSelectedUserHooksPost	Post /users/{selected_user}/hooks
WebhooksApi	UsersSelectedUserHooksUidDelete	Delete /users/{selected_user}/hooks/{uid}
WebhooksApi	UsersSelectedUserHooksUidGet	Get /users/{selected_user}/hooks/{uid}
WebhooksApi	UsersSelectedUserHooksUidPut	Put /users/{selected_user}/hooks/{uid}
WebhooksApi	WorkspacesWorkspaceHooksGet	Get /workspaces/{workspace}/hooks
WebhooksApi	WorkspacesWorkspaceHooksPost	Post /workspaces/{workspace}/hooks
WebhooksApi	WorkspacesWorkspaceHooksUidDelete	Delete /workspaces/{workspace}/hooks/{uid}
WebhooksApi	WorkspacesWorkspaceHooksUidGet	Get /workspaces/{workspace}/hooks/{uid}
WebhooksApi	WorkspacesWorkspaceHooksUidPut	Put /workspaces/{workspace}/hooks/{uid}
WorkspacesApi	UserPermissionsWorkspacesGet	Get /user/permissions/workspaces
WorkspacesApi	WorkspacesGet	Get /workspaces
WorkspacesApi	WorkspacesWorkspaceGet	Get /workspaces/{workspace}
WorkspacesApi	WorkspacesWorkspaceHooksGet	Get /workspaces/{workspace}/hooks
WorkspacesApi	WorkspacesWorkspaceHooksPost	Post /workspaces/{workspace}/hooks
WorkspacesApi	WorkspacesWorkspaceHooksUidDelete	Delete /workspaces/{workspace}/hooks/{uid}
WorkspacesApi	WorkspacesWorkspaceHooksUidGet	Get /workspaces/{workspace}/hooks/{uid}
WorkspacesApi	WorkspacesWorkspaceHooksUidPut	Put /workspaces/{workspace}/hooks/{uid}
WorkspacesApi	WorkspacesWorkspaceMembersGet	Get /workspaces/{workspace}/members
WorkspacesApi	WorkspacesWorkspaceMembersMemberGet	Get /workspaces/{workspace}/members/{member}
WorkspacesApi	WorkspacesWorkspacePermissionsGet	Get /workspaces/{workspace}/permissions
WorkspacesApi	WorkspacesWorkspacePermissionsRepositoriesGet	Get /workspaces/{workspace}/permissions/repositories
WorkspacesApi	WorkspacesWorkspacePermissionsRepositoriesRepoSlugGet	Get /workspaces/{workspace}/permissions/repositories/{repo_slug}
WorkspacesApi	WorkspacesWorkspaceProjectsGet	Get /workspaces/{workspace}/projects
WorkspacesApi	WorkspacesWorkspaceProjectsProjectKeyGet	Get /workspaces/{workspace}/projects/{project_key}

Documentation For Models

• Account
• AccountLinks
• Author
• BaseCommit
• Branch
• BranchRestriction
• BranchingModel
• BranchingModelBranchTypes
• BranchingModelDevelopment
• BranchingModelSettings
• BranchingModelSettingsBranchTypes
• BranchingModelSettingsDevelopment
• BranchingModelSettingsLinks
• BranchingModelSettingsProduction
• Branchrestriction
• Comment
• CommentInline
• CommentLinks
• Commit
• CommitComment
• CommitFile
• CommitStatus
• CommitStatusLinks
• Commitstatus
• Component
• DdevReport
• DeployKey
• Deployment
• DeploymentAllOf
• DeploymentEnvironment
• DeploymentEnvironmentAllOf
• DeploymentRelease
• DeploymentReleaseAllOf
• DeploymentState
• DeploymentStateCompleted
• DeploymentStateCompletedAllOf
• DeploymentStateCompletedStatus
• DeploymentStateCompletedStatusFailed
• DeploymentStateCompletedStatusFailedAllOf
• DeploymentStateCompletedStatusStopped
• DeploymentStateCompletedStatusStoppedAllOf
• DeploymentStateCompletedStatusSuccessful
• DeploymentStateCompletedStatusSuccessfulAllOf
• DeploymentStateInProgress
• DeploymentStateInProgressAllOf
• DeploymentStateUndeployed
• DeploymentStateUndeployedAllOf
• DeploymentVariable
• DeploymentVariableAllOf
• DeploymentsDdevDeploymentEnvironment
• DeploymentsStgWestDeploymentEnvironment
• Diffstat
• ErrorError
• ExportOptions
• Group
• GroupLinks
• HookEvent
• Issue
• IssueAttachment
• IssueChange
• IssueChangeChanges
• IssueChangeChangesAssignee
• IssueChangeLinks
• IssueComment
• IssueContent
• IssueJobStatus
• IssueLinks
• JiraProject
• JiraSite
• Link
• Milestone
• ModelError
• Object
• Page
• PaginatedAnnotations
• PaginatedBranches
• PaginatedBranchrestrictions
• PaginatedChangeset
• PaginatedCommitComments
• PaginatedCommitstatuses
• PaginatedComponents
• PaginatedDeployKeys
• PaginatedDeploymentVariable
• PaginatedDeployments
• PaginatedDiffstats
• PaginatedEnvironments
• PaginatedFiles
• PaginatedHookEvents
• PaginatedIssueAttachments
• PaginatedIssueComments
• PaginatedIssues
• PaginatedLogEntries
• PaginatedMilestones
• PaginatedPipelineCaches
• PaginatedPipelineKnownHosts
• PaginatedPipelineScheduleExecutions
• PaginatedPipelineSchedules
• PaginatedPipelineSteps
• PaginatedPipelineVariables
• PaginatedPipelines
• PaginatedProjects
• PaginatedPullrequestComments
• PaginatedPullrequests
• PaginatedRefs
• PaginatedReports
• PaginatedRepositories
• PaginatedRepositoryPermissions
• PaginatedSnippetComments
• PaginatedSnippetCommit
• PaginatedSnippets
• PaginatedSshUserKeys
• PaginatedTags
• PaginatedTeamPermissions
• PaginatedTeams
• PaginatedTreeentries
• PaginatedUsers
• PaginatedVersions
• PaginatedWebhookSubscriptions
• PaginatedWorkspaceMemberships
• PaginatedWorkspaces
• Participant
• Pipeline
• PipelineAllOf
• PipelineBuildNumber
• PipelineBuildNumberAllOf
• PipelineCache
• PipelineCacheAllOf
• PipelineCacheContentUri
• PipelineCommand
• PipelineCommitTarget
• PipelineCommitTargetAllOf
• PipelineError
• PipelineErrorAllOf
• PipelineImage
• PipelineKnownHost
• PipelineKnownHostAllOf
• PipelineRefTarget
• PipelineRefTargetAllOf
• PipelineSchedule
• PipelineScheduleAllOf
• PipelineScheduleExecution
• PipelineScheduleExecutionErrored
• PipelineScheduleExecutionErroredAllOf
• PipelineScheduleExecutionExecuted
• PipelineScheduleExecutionExecutedAllOf
• PipelineSelector
• PipelineSelectorAllOf
• PipelineSshKeyPair
• PipelineSshKeyPairAllOf
• PipelineSshPublicKey
• PipelineSshPublicKeyAllOf
• PipelineState
• PipelineStateCompleted
• PipelineStateCompletedAllOf
• PipelineStateCompletedError
• PipelineStateCompletedErrorAllOf
• PipelineStateCompletedExpired
• PipelineStateCompletedExpiredAllOf
• PipelineStateCompletedFailed
• PipelineStateCompletedFailedAllOf
• PipelineStateCompletedResult
• PipelineStateCompletedStopped
• PipelineStateCompletedStoppedAllOf
• PipelineStateCompletedSuccessful
• PipelineStateCompletedSuccessfulAllOf
• PipelineStateInProgress
• PipelineStateInProgressAllOf
• PipelineStateInProgressPaused
• PipelineStateInProgressPausedAllOf
• PipelineStateInProgressRunning
• PipelineStateInProgressRunningAllOf
• PipelineStateInProgressStage
• PipelineStatePending
• PipelineStatePendingAllOf
• PipelineStep
• PipelineStepAllOf
• PipelineStepError
• PipelineStepErrorAllOf
• PipelineStepState
• PipelineStepStateCompleted
• PipelineStepStateCompletedAllOf
• PipelineStepStateCompletedError
• PipelineStepStateCompletedErrorAllOf
• PipelineStepStateCompletedExpired
• PipelineStepStateCompletedExpiredAllOf
• PipelineStepStateCompletedFailed
• PipelineStepStateCompletedFailedAllOf
• PipelineStepStateCompletedNotRun
• PipelineStepStateCompletedNotRunAllOf
• PipelineStepStateCompletedResult
• PipelineStepStateCompletedStopped
• PipelineStepStateCompletedStoppedAllOf
• PipelineStepStateCompletedSuccessful
• PipelineStepStateCompletedSuccessfulAllOf
• PipelineStepStateInProgress
• PipelineStepStateInProgressAllOf
• PipelineStepStatePending
• PipelineStepStatePendingAllOf
• PipelineStepStateReady
• PipelineStepStateReadyAllOf
• PipelineTarget
• PipelineTrigger
• PipelineTriggerManual
• PipelineTriggerPush
• PipelineVariable
• PipelineVariableAllOf
• PipelinesConfig
• PipelinesConfigAllOf
• PipelinesDdevPipelineStep
• PipelinesStgWestPipelineStep
• Project
• ProjectLinks
• PullRequest
• PullRequestBranch
• PullRequestComment
• PullRequestCommit
• PullRequestLinks
• Pullrequest
• PullrequestComment
• PullrequestEndpoint
• PullrequestMergeParameters
• Ref
• RefLinks
• RenderedPullRequestMarkup
• Report
• ReportAllOf
• ReportAnnotation
• ReportAnnotationAllOf
• ReportData
• Repository
• RepositoryLinks
• RepositoryPermission
• SSHAccountKey
• SSHKey
• SearchCodeSearchResult
• SearchContentMatch
• SearchLine
• SearchResultPage
• SearchSegment
• Snippet
• SnippetComment
• SnippetCommit
• SnippetCommitLinks
• SshAccountKey
• SshKey
• StgWestReport
• SubjectTypes
• SubjectTypesRepository
• Tag
• Team
• TeamPermission
• Treeentry
• User
• Version
• WebhookSubscription
• Workspace
• WorkspaceLinks
• WorkspaceMembership

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

basic

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://bitbucket.org/site/oauth2/authorize
• Scopes:
• wiki: Read and modify your repositories' wikis
• pullrequest:write: Read and modify your repositories and their pull requests
• pipeline:variable: Access your repositories' build pipelines and configure their variables
• project:write: Read and modify your workspace's project settings, and read and transfer repositories within your workspace's projects
• pipeline:write: Access and rerun your repositories' build pipelines
• snippet: Read your snippets
• repository:delete: Delete your repositories
• repository:write: Read and modify your repositories
• issue: Read your repositories' issues
• email: Read your account's primary email address
• repository: Read your repositories
• issue:write: Read and modify your repositories' issues
• webhook: Read and modify your repositories' webhooks
• pipeline: Access your repositories' build pipelines
• snippet:write: Read and modify your snippets
• account: Read your account information
• repository:admin: Administer your repositories
• pullrequest: Read your repositories and their pull requests
• project: Read your workspace's project settings and read repositories contained within your workspace's projects
• team: Read your team membership information
• team:write: Read and modify your team membership information
• account:write: Read and modify your account information

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

[email protected]