Categorygithub.com/finiteinfinity/bitbucket-openapi-go
repositorypackage
0.0.3
Repository: https://github.com/finiteinfinity/bitbucket-openapi-go.git
Documentation: pkg.go.dev

# README

Go API client for bitbucket

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.

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 bitbucket "github.com/finiteinfinity/bitbucket-openapi-go"

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(), bitbucket.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(), bitbucket.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 identified 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(), bitbucket.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), bitbucket.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

ClassMethodHTTP requestDescription
AddonApiAddonDeleteDelete /addonDelete an app
AddonApiAddonLinkersGetGet /addon/linkersList linkers for an app
AddonApiAddonLinkersLinkerKeyGetGet /addon/linkers/{linker_key}Get a linker for an app
AddonApiAddonLinkersLinkerKeyValuesDeleteDelete /addon/linkers/{linker_key}/valuesDelete all linker values
AddonApiAddonLinkersLinkerKeyValuesGetGet /addon/linkers/{linker_key}/valuesList linker values for a linker
AddonApiAddonLinkersLinkerKeyValuesPostPost /addon/linkers/{linker_key}/valuesCreate a linker value
AddonApiAddonLinkersLinkerKeyValuesPutPut /addon/linkers/{linker_key}/valuesUpdate a linker value
AddonApiAddonLinkersLinkerKeyValuesValueIdDeleteDelete /addon/linkers/{linker_key}/values/{value_id}Delete a linker value
AddonApiAddonLinkersLinkerKeyValuesValueIdGetGet /addon/linkers/{linker_key}/values/{value_id}Get a linker value
AddonApiAddonPutPut /addonUpdate an installed app
BranchRestrictionsApiRepositoriesWorkspaceRepoSlugBranchRestrictionsGetGet /repositories/{workspace}/{repo_slug}/branch-restrictionsList branch restrictions
BranchRestrictionsApiRepositoriesWorkspaceRepoSlugBranchRestrictionsIdDeleteDelete /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}Delete a branch restriction rule
BranchRestrictionsApiRepositoriesWorkspaceRepoSlugBranchRestrictionsIdGetGet /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}Get a branch restriction rule
BranchRestrictionsApiRepositoriesWorkspaceRepoSlugBranchRestrictionsIdPutPut /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}Update a branch restriction rule
BranchRestrictionsApiRepositoriesWorkspaceRepoSlugBranchRestrictionsPostPost /repositories/{workspace}/{repo_slug}/branch-restrictionsCreate a branch restriction rule
BranchingModelApiRepositoriesWorkspaceRepoSlugBranchingModelGetGet /repositories/{workspace}/{repo_slug}/branching-modelGet the branching model for a repository
BranchingModelApiRepositoriesWorkspaceRepoSlugBranchingModelSettingsGetGet /repositories/{workspace}/{repo_slug}/branching-model/settingsGet the branching model config for a repository
BranchingModelApiRepositoriesWorkspaceRepoSlugBranchingModelSettingsPutPut /repositories/{workspace}/{repo_slug}/branching-model/settingsUpdate the branching model config for a repository
CommitStatusesApiRepositoriesWorkspaceRepoSlugCommitCommitStatusesBuildKeyGetGet /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}Get a build status for a commit
CommitStatusesApiRepositoriesWorkspaceRepoSlugCommitCommitStatusesBuildKeyPutPut /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}Update a build status for a commit
CommitStatusesApiRepositoriesWorkspaceRepoSlugCommitCommitStatusesBuildPostPost /repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/buildCreate a build status for a commit
CommitStatusesApiRepositoriesWorkspaceRepoSlugCommitCommitStatusesGetGet /repositories/{workspace}/{repo_slug}/commit/{commit}/statusesList commit statuses for a commit
CommitStatusesApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdStatusesGetGet /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statusesList commit statuses for a pull request
CommitsApiBulkCreateOrUpdateAnnotationsPost /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotationsBulk create or update annotations
CommitsApiCreateOrUpdateAnnotationPut /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}Create or update an annotation
CommitsApiCreateOrUpdateReportPut /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}Create or update a report
CommitsApiDeleteAnnotationDelete /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}Delete an annotation
CommitsApiDeleteReportDelete /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}Delete a report
CommitsApiGetAnnotationGet /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}Get an annotation
CommitsApiGetAnnotationsForReportGet /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotationsList annotations
CommitsApiGetReportGet /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}Get a report
CommitsApiGetReportsForCommitGet /repositories/{workspace}/{repo_slug}/commit/{commit}/reportsList reports
CommitsApiRepositoriesWorkspaceRepoSlugCommitCommitApproveDeleteDelete /repositories/{workspace}/{repo_slug}/commit/{commit}/approveUnapprove a commit
CommitsApiRepositoriesWorkspaceRepoSlugCommitCommitApprovePostPost /repositories/{workspace}/{repo_slug}/commit/{commit}/approveApprove a commit
CommitsApiRepositoriesWorkspaceRepoSlugCommitCommitCommentsCommentIdGetGet /repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id}Get a commit comment
CommitsApiRepositoriesWorkspaceRepoSlugCommitCommitCommentsGetGet /repositories/{workspace}/{repo_slug}/commit/{commit}/commentsList a commit's comments
CommitsApiRepositoriesWorkspaceRepoSlugCommitCommitCommentsPostPost /repositories/{workspace}/{repo_slug}/commit/{commit}/commentsCreate comment for a commit
CommitsApiRepositoriesWorkspaceRepoSlugCommitCommitGetGet /repositories/{workspace}/{repo_slug}/commit/{commit}Get a commit
CommitsApiRepositoriesWorkspaceRepoSlugCommitsGetGet /repositories/{workspace}/{repo_slug}/commitsList commits
CommitsApiRepositoriesWorkspaceRepoSlugCommitsPostPost /repositories/{workspace}/{repo_slug}/commitsList commits with include/exclude
CommitsApiRepositoriesWorkspaceRepoSlugCommitsRevisionGetGet /repositories/{workspace}/{repo_slug}/commits/{revision}List commits for revision
CommitsApiRepositoriesWorkspaceRepoSlugCommitsRevisionPostPost /repositories/{workspace}/{repo_slug}/commits/{revision}List commits for revision using include/exclude
CommitsApiRepositoriesWorkspaceRepoSlugDiffSpecGetGet /repositories/{workspace}/{repo_slug}/diff/{spec}Compare two commits
CommitsApiRepositoriesWorkspaceRepoSlugDiffstatSpecGetGet /repositories/{workspace}/{repo_slug}/diffstat/{spec}Compare two commit diff stats
CommitsApiRepositoriesWorkspaceRepoSlugMergeBaseRevspecGetGet /repositories/{workspace}/{repo_slug}/merge-base/{revspec}Get the common ancestor between two commits
CommitsApiRepositoriesWorkspaceRepoSlugPatchSpecGetGet /repositories/{workspace}/{repo_slug}/patch/{spec}Get a patch for two commits
DeploymentsApiCreateEnvironmentPost /repositories/{workspace}/{repo_slug}/environments/Create an environment
DeploymentsApiDeleteEnvironmentForRepositoryDelete /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}Delete an environment
DeploymentsApiGetDeploymentForRepositoryGet /repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid}Get a deployment
DeploymentsApiGetDeploymentsForRepositoryGet /repositories/{workspace}/{repo_slug}/deployments/List deployments
DeploymentsApiGetEnvironmentForRepositoryGet /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}Get an environment
DeploymentsApiGetEnvironmentsForRepositoryGet /repositories/{workspace}/{repo_slug}/environments/List environments
DeploymentsApiRepositoriesWorkspaceRepoSlugDeployKeysGetGet /repositories/{workspace}/{repo_slug}/deploy-keysList deploy keys
DeploymentsApiRepositoriesWorkspaceRepoSlugDeployKeysKeyIdDeleteDelete /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}Delete a deploy key
DeploymentsApiRepositoriesWorkspaceRepoSlugDeployKeysKeyIdGetGet /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}Get a deploy key
DeploymentsApiRepositoriesWorkspaceRepoSlugDeployKeysKeyIdPutPut /repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}Update a deploy key
DeploymentsApiRepositoriesWorkspaceRepoSlugDeployKeysPostPost /repositories/{workspace}/{repo_slug}/deploy-keysAdd a deploy key
DeploymentsApiUpdateEnvironmentForRepositoryPost /repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/changes/Update an environment
DownloadsApiRepositoriesWorkspaceRepoSlugDownloadsFilenameDeleteDelete /repositories/{workspace}/{repo_slug}/downloads/{filename}Delete a download artifact
DownloadsApiRepositoriesWorkspaceRepoSlugDownloadsFilenameGetGet /repositories/{workspace}/{repo_slug}/downloads/{filename}Get a download artifact link
DownloadsApiRepositoriesWorkspaceRepoSlugDownloadsGetGet /repositories/{workspace}/{repo_slug}/downloadsList download artifacts
DownloadsApiRepositoriesWorkspaceRepoSlugDownloadsPostPost /repositories/{workspace}/{repo_slug}/downloadsUpload a download artifact
IssueTrackerApiRepositoriesWorkspaceRepoSlugComponentsComponentIdGetGet /repositories/{workspace}/{repo_slug}/components/{component_id}Get a component for issues
IssueTrackerApiRepositoriesWorkspaceRepoSlugComponentsGetGet /repositories/{workspace}/{repo_slug}/componentsList components
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesExportPostPost /repositories/{workspace}/{repo_slug}/issues/exportExport issues
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesExportRepoNameIssuesTaskIdZipGetGet /repositories/{workspace}/{repo_slug}/issues/export/{repo_name}-issues-{task_id}.zipCheck issue export status
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesGetGet /repositories/{workspace}/{repo_slug}/issuesList issues
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesImportGetGet /repositories/{workspace}/{repo_slug}/issues/importCheck issue import status
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesImportPostPost /repositories/{workspace}/{repo_slug}/issues/importImport issues
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsGetGet /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachmentsList attachments for an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPathDeleteDelete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path}Delete an attachment for an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPathGetGet /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path}Get attachment for an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdAttachmentsPostPost /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachmentsUpload an attachment to an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdChangesChangeIdGetGet /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes/{change_id}Get issue change object
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdChangesGetGet /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changesList changes on an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdChangesPostPost /repositories/{workspace}/{repo_slug}/issues/{issue_id}/changesModify the state of an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdDeleteDelete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id}Delete a comment on an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdGetGet /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id}Get a comment on an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsCommentIdPutPut /repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id}Update a comment on an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsGetGet /repositories/{workspace}/{repo_slug}/issues/{issue_id}/commentsList comments on an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdCommentsPostPost /repositories/{workspace}/{repo_slug}/issues/{issue_id}/commentsCreate a comment on an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdDeleteDelete /repositories/{workspace}/{repo_slug}/issues/{issue_id}Delete an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdGetGet /repositories/{workspace}/{repo_slug}/issues/{issue_id}Get an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdPutPut /repositories/{workspace}/{repo_slug}/issues/{issue_id}Update an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdVoteDeleteDelete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/voteRemove vote for an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdVoteGetGet /repositories/{workspace}/{repo_slug}/issues/{issue_id}/voteCheck if current user voted for an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdVotePutPut /repositories/{workspace}/{repo_slug}/issues/{issue_id}/voteVote for an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdWatchDeleteDelete /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watchStop watching an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdWatchGetGet /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watchCheck if current user is watching a issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesIssueIdWatchPutPut /repositories/{workspace}/{repo_slug}/issues/{issue_id}/watchWatch an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugIssuesPostPost /repositories/{workspace}/{repo_slug}/issuesCreate an issue
IssueTrackerApiRepositoriesWorkspaceRepoSlugMilestonesGetGet /repositories/{workspace}/{repo_slug}/milestonesList milestones
IssueTrackerApiRepositoriesWorkspaceRepoSlugMilestonesMilestoneIdGetGet /repositories/{workspace}/{repo_slug}/milestones/{milestone_id}Get a milestone
IssueTrackerApiRepositoriesWorkspaceRepoSlugVersionsGetGet /repositories/{workspace}/{repo_slug}/versionsList defined versions for issues
IssueTrackerApiRepositoriesWorkspaceRepoSlugVersionsVersionIdGetGet /repositories/{workspace}/{repo_slug}/versions/{version_id}Get a defined version for issues
PipelinesApiCreateDeploymentVariablePost /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variablesCreate a variable for an environment
PipelinesApiCreatePipelineForRepositoryPost /repositories/{workspace}/{repo_slug}/pipelines/Run a pipeline
PipelinesApiCreatePipelineVariableForTeamPost /teams/{username}/pipelines_config/variables/Create a variable for a user
PipelinesApiCreatePipelineVariableForUserPost /users/{selected_user}/pipelines_config/variables/Create a variable for a user
PipelinesApiCreatePipelineVariableForWorkspacePost /workspaces/{workspace}/pipelines-config/variablesCreate a variable for a workspace
PipelinesApiCreateRepositoryPipelineKnownHostPost /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/Create a known host
PipelinesApiCreateRepositoryPipelineSchedulePost /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/Create a schedule
PipelinesApiCreateRepositoryPipelineVariablePost /repositories/{workspace}/{repo_slug}/pipelines_config/variables/Create a variable for a repository
PipelinesApiDeleteDeploymentVariableDelete /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}Delete a variable for an environment
PipelinesApiDeletePipelineVariableForTeamDelete /teams/{username}/pipelines_config/variables/{variable_uuid}Delete a variable for a team
PipelinesApiDeletePipelineVariableForUserDelete /users/{selected_user}/pipelines_config/variables/{variable_uuid}Delete a variable for a user
PipelinesApiDeletePipelineVariableForWorkspaceDelete /workspaces/{workspace}/pipelines-config/variables/{variable_uuid}Delete a variable for a workspace
PipelinesApiDeleteRepositoryPipelineCacheDelete /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}Delete a cache
PipelinesApiDeleteRepositoryPipelineKeyPairDelete /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pairDelete SSH key pair
PipelinesApiDeleteRepositoryPipelineKnownHostDelete /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}Delete a known host
PipelinesApiDeleteRepositoryPipelineScheduleDelete /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}Delete a schedule
PipelinesApiDeleteRepositoryPipelineVariableDelete /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}Delete a variable for a repository
PipelinesApiGetDeploymentVariablesGet /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variablesList variables for an environment
PipelinesApiGetOIDCConfigurationGet /workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configurationGet OpenID configuration for OIDC in Pipelines
PipelinesApiGetOIDCKeysGet /workspaces/{workspace}/pipelines-config/identity/oidc/keys.jsonGet keys for OIDC in Pipelines
PipelinesApiGetPipelineContainerLogGet /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid}Get the logs for the build container or a service container for a given step of a pipeline.
PipelinesApiGetPipelineForRepositoryGet /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}Get a pipeline
PipelinesApiGetPipelineStepForRepositoryGet /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}Get a step of a pipeline
PipelinesApiGetPipelineStepLogForRepositoryGet /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logGet log file for a step
PipelinesApiGetPipelineStepsForRepositoryGet /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/List steps for a pipeline
PipelinesApiGetPipelineTestReportTestCaseReasonsGet /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasonsGet test case reasons (output) for a given test case in a step of a pipeline.
PipelinesApiGetPipelineTestReportTestCasesGet /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_casesGet test cases for a given step of a pipeline.
PipelinesApiGetPipelineTestReportsGet /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reportsGet a summary of test reports for a given step of a pipeline.
PipelinesApiGetPipelineVariableForTeamGet /teams/{username}/pipelines_config/variables/{variable_uuid}Get a variable for a team
PipelinesApiGetPipelineVariableForUserGet /users/{selected_user}/pipelines_config/variables/{variable_uuid}Get a variable for a user
PipelinesApiGetPipelineVariableForWorkspaceGet /workspaces/{workspace}/pipelines-config/variables/{variable_uuid}Get variable for a workspace
PipelinesApiGetPipelineVariablesForTeamGet /teams/{username}/pipelines_config/variables/List variables for an account
PipelinesApiGetPipelineVariablesForUserGet /users/{selected_user}/pipelines_config/variables/List variables for a user
PipelinesApiGetPipelineVariablesForWorkspaceGet /workspaces/{workspace}/pipelines-config/variablesList variables for a workspace
PipelinesApiGetPipelinesForRepositoryGet /repositories/{workspace}/{repo_slug}/pipelines/List pipelines
PipelinesApiGetRepositoryPipelineCacheContentURIGet /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uriGet cache content URI
PipelinesApiGetRepositoryPipelineCachesGet /repositories/{workspace}/{repo_slug}/pipelines-config/caches/List caches
PipelinesApiGetRepositoryPipelineConfigGet /repositories/{workspace}/{repo_slug}/pipelines_configGet configuration
PipelinesApiGetRepositoryPipelineKnownHostGet /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}Get a known host
PipelinesApiGetRepositoryPipelineKnownHostsGet /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/List known hosts
PipelinesApiGetRepositoryPipelineScheduleGet /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}Get a schedule
PipelinesApiGetRepositoryPipelineScheduleExecutionsGet /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions/List executions of a schedule
PipelinesApiGetRepositoryPipelineSchedulesGet /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/List schedules
PipelinesApiGetRepositoryPipelineSshKeyPairGet /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pairGet SSH key pair
PipelinesApiGetRepositoryPipelineVariableGet /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}Get a variable for a repository
PipelinesApiGetRepositoryPipelineVariablesGet /repositories/{workspace}/{repo_slug}/pipelines_config/variables/List variables for a repository
PipelinesApiStopPipelinePost /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipelineStop a pipeline
PipelinesApiUpdateDeploymentVariablePut /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}Update a variable for an environment
PipelinesApiUpdatePipelineVariableForTeamPut /teams/{username}/pipelines_config/variables/{variable_uuid}Update a variable for a team
PipelinesApiUpdatePipelineVariableForUserPut /users/{selected_user}/pipelines_config/variables/{variable_uuid}Update a variable for a user
PipelinesApiUpdatePipelineVariableForWorkspacePut /workspaces/{workspace}/pipelines-config/variables/{variable_uuid}Update variable for a workspace
PipelinesApiUpdateRepositoryBuildNumberPut /repositories/{workspace}/{repo_slug}/pipelines_config/build_numberUpdate the next build number
PipelinesApiUpdateRepositoryPipelineConfigPut /repositories/{workspace}/{repo_slug}/pipelines_configUpdate configuration
PipelinesApiUpdateRepositoryPipelineKeyPairPut /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pairUpdate SSH key pair
PipelinesApiUpdateRepositoryPipelineKnownHostPut /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}Update a known host
PipelinesApiUpdateRepositoryPipelineSchedulePut /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}Update a schedule
PipelinesApiUpdateRepositoryPipelineVariablePut /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}Update a variable for a repository
ProjectsApiTeamsUsernameProjectsGetGet /teams/{username}/projects/List a projects for a team
ProjectsApiTeamsUsernameProjectsPostPost /teams/{username}/projects/Create a project for a team
ProjectsApiTeamsUsernameProjectsProjectKeyDeleteDelete /teams/{username}/projects/{project_key}Delete a project
ProjectsApiTeamsUsernameProjectsProjectKeyGetGet /teams/{username}/projects/{project_key}Get a project
ProjectsApiTeamsUsernameProjectsProjectKeyPutPut /teams/{username}/projects/{project_key}Update a project
ProjectsApiWorkspacesWorkspaceProjectsPostPost /workspaces/{workspace}/projectsCreate a project in a workspace
ProjectsApiWorkspacesWorkspaceProjectsProjectKeyDeleteDelete /workspaces/{workspace}/projects/{project_key}Delete a project for a workspace
ProjectsApiWorkspacesWorkspaceProjectsProjectKeyGetGet /workspaces/{workspace}/projects/{project_key}Get a project for a workspace
ProjectsApiWorkspacesWorkspaceProjectsProjectKeyPutPut /workspaces/{workspace}/projects/{project_key}Update a project for a workspace
PropertiesApiDeleteCommitHostedPropertyValueDelete /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}Delete a commit application property
PropertiesApiDeletePullRequestHostedPropertyValueDelete /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}Delete a pull request application property
PropertiesApiDeleteRepositoryHostedPropertyValueDelete /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}Delete a repository application property
PropertiesApiDeleteUserHostedPropertyValueDelete /users/{selected_user}/properties/{app_key}/{property_name}Delete a user application property
PropertiesApiGetCommitHostedPropertyValueGet /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}Get a commit application property
PropertiesApiGetPullRequestHostedPropertyValueGet /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}Get a pull request application property
PropertiesApiGetRepositoryHostedPropertyValueGet /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}Get a repository application property
PropertiesApiRetrieveUserHostedPropertyValueGet /users/{selected_user}/properties/{app_key}/{property_name}Get a user application property
PropertiesApiUpdateCommitHostedPropertyValuePut /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}Update a commit application property
PropertiesApiUpdatePullRequestHostedPropertyValuePut /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}Update a pull request application property
PropertiesApiUpdateRepositoryHostedPropertyValuePut /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}Update a repository application property
PropertiesApiUpdateUserHostedPropertyValuePut /users/{selected_user}/properties/{app_key}/{property_name}Update a user application property
PullrequestsApiGetPullrequestsForCommitGet /repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequestsList pull requests that contain a commit
PullrequestsApiPullrequestsSelectedUserGetGet /pullrequests/{selected_user}List pull requests for a user
PullrequestsApiRepositoriesWorkspaceRepoSlugDefaultReviewersGetGet /repositories/{workspace}/{repo_slug}/default-reviewersList default reviewers
PullrequestsApiRepositoriesWorkspaceRepoSlugDefaultReviewersTargetUsernameDeleteDelete /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}Remove a user from the default reviewers
PullrequestsApiRepositoriesWorkspaceRepoSlugDefaultReviewersTargetUsernameGetGet /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}Get a default reviewer
PullrequestsApiRepositoriesWorkspaceRepoSlugDefaultReviewersTargetUsernamePutPut /repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}Add a user to the default reviewers
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsActivityGetGet /repositories/{workspace}/{repo_slug}/pullrequests/activityList a pull request activity log
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsGetGet /repositories/{workspace}/{repo_slug}/pullrequestsList pull requests
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPostPost /repositories/{workspace}/{repo_slug}/pullrequestsCreate a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdActivityGetGet /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activityList a pull request activity log
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdApproveDeleteDelete /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approveUnapprove a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdApprovePostPost /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approveApprove a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsCommentIdDeleteDelete /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}Delete a comment on a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsCommentIdGetGet /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}Get a comment on a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsCommentIdPutPut /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}Update a comment on a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsGetGet /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commentsList comments on a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommentsPostPost /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commentsCreate a comment on a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdCommitsGetGet /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commitsList commits on a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdDeclinePostPost /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/declineDecline a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdDiffGetGet /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffList changes in a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdDiffstatGetGet /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstatGet the diff stat for a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdGetGet /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}Get a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdMergePostPost /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/mergeMerge a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdMergeTaskStatusTaskIdGetGet /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge/task-status/{task_id}Get the merge task status for a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdPatchGetGet /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patchGet the patch for a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdPutPut /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}Update a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdRequestChangesDeleteDelete /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changesRemove change request for a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdRequestChangesPostPost /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changesRequest changes for a pull request
PullrequestsApiRepositoriesWorkspaceRepoSlugPullrequestsPullRequestIdStatusesGetGet /repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statusesList commit statuses for a pull request
RefsApiRepositoriesWorkspaceRepoSlugRefsBranchesGetGet /repositories/{workspace}/{repo_slug}/refs/branchesList open branches
RefsApiRepositoriesWorkspaceRepoSlugRefsBranchesNameDeleteDelete /repositories/{workspace}/{repo_slug}/refs/branches/{name}Delete a branch
RefsApiRepositoriesWorkspaceRepoSlugRefsBranchesNameGetGet /repositories/{workspace}/{repo_slug}/refs/branches/{name}Get a branch
RefsApiRepositoriesWorkspaceRepoSlugRefsBranchesPostPost /repositories/{workspace}/{repo_slug}/refs/branchesCreate a branch
RefsApiRepositoriesWorkspaceRepoSlugRefsGetGet /repositories/{workspace}/{repo_slug}/refsList branches and tags
RefsApiRepositoriesWorkspaceRepoSlugRefsTagsGetGet /repositories/{workspace}/{repo_slug}/refs/tagsList tags
RefsApiRepositoriesWorkspaceRepoSlugRefsTagsNameDeleteDelete /repositories/{workspace}/{repo_slug}/refs/tags/{name}Delete a tag
RefsApiRepositoriesWorkspaceRepoSlugRefsTagsNameGetGet /repositories/{workspace}/{repo_slug}/refs/tags/{name}Get a tag
RefsApiRepositoriesWorkspaceRepoSlugRefsTagsPostPost /repositories/{workspace}/{repo_slug}/refs/tagsCreate a tag
ReportsApiBulkCreateOrUpdateAnnotationsPost /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotationsBulk create or update annotations
ReportsApiCreateOrUpdateAnnotationPut /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}Create or update an annotation
ReportsApiCreateOrUpdateReportPut /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}Create or update a report
ReportsApiDeleteAnnotationDelete /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}Delete an annotation
ReportsApiDeleteReportDelete /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}Delete a report
ReportsApiGetAnnotationGet /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}Get an annotation
ReportsApiGetAnnotationsForReportGet /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotationsList annotations
ReportsApiGetReportGet /repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}Get a report
ReportsApiGetReportsForCommitGet /repositories/{workspace}/{repo_slug}/commit/{commit}/reportsList reports
RepositoriesApiRepositoriesGetGet /repositoriesList public repositories
RepositoriesApiRepositoriesWorkspaceGetGet /repositories/{workspace}List repositories in a workspace
RepositoriesApiRepositoriesWorkspaceRepoSlugDeleteDelete /repositories/{workspace}/{repo_slug}Delete a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugFilehistoryCommitPathGetGet /repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path}List commits that modified a file
RepositoriesApiRepositoriesWorkspaceRepoSlugForksGetGet /repositories/{workspace}/{repo_slug}/forksList repository forks
RepositoriesApiRepositoriesWorkspaceRepoSlugForksPostPost /repositories/{workspace}/{repo_slug}/forksFork a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugGetGet /repositories/{workspace}/{repo_slug}Get a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugHooksGetGet /repositories/{workspace}/{repo_slug}/hooksList webhooks for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugHooksPostPost /repositories/{workspace}/{repo_slug}/hooksCreate a webhook for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugHooksUidDeleteDelete /repositories/{workspace}/{repo_slug}/hooks/{uid}Delete a webhook for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugHooksUidGetGet /repositories/{workspace}/{repo_slug}/hooks/{uid}Get a webhook for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugHooksUidPutPut /repositories/{workspace}/{repo_slug}/hooks/{uid}Update a webhook for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugPermissionsConfigGroupsGetGet /repositories/{workspace}/{repo_slug}/permissions-config/groupsList explicit group permissions for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugPermissionsConfigGroupsGroupSlugDeleteDelete /repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}Delete an explicit group permission for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugPermissionsConfigGroupsGroupSlugGetGet /repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}Get an explicit group permission for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugPermissionsConfigGroupsGroupSlugPutPut /repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}Update an explicit group permission for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugPermissionsConfigUsersGetGet /repositories/{workspace}/{repo_slug}/permissions-config/usersList explicit user permissions for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugPermissionsConfigUsersSelectedUserIdDeleteDelete /repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id}Delete an explicit user permission for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugPermissionsConfigUsersSelectedUserIdGetGet /repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id}Get an explicit user permission for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugPermissionsConfigUsersSelectedUserIdPutPut /repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id}Update an explicit user permission for a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugPostPost /repositories/{workspace}/{repo_slug}Create a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugPutPut /repositories/{workspace}/{repo_slug}Update a repository
RepositoriesApiRepositoriesWorkspaceRepoSlugSrcCommitPathGetGet /repositories/{workspace}/{repo_slug}/src/{commit}/{path}Get file or directory contents
RepositoriesApiRepositoriesWorkspaceRepoSlugSrcGetGet /repositories/{workspace}/{repo_slug}/srcGet the root directory of the main branch
RepositoriesApiRepositoriesWorkspaceRepoSlugSrcPostPost /repositories/{workspace}/{repo_slug}/srcCreate a commit by uploading a file
RepositoriesApiRepositoriesWorkspaceRepoSlugWatchersGetGet /repositories/{workspace}/{repo_slug}/watchersList repositories watchers
RepositoriesApiUserPermissionsRepositoriesGetGet /user/permissions/repositoriesList repository permissions for a user
SearchApiSearchAccountGet /users/{selected_user}/search/codeSearch for code in a user's repositories
SearchApiSearchTeamGet /teams/{username}/search/codeSearch for code in a team's repositories
SearchApiSearchWorkspaceGet /workspaces/{workspace}/search/codeSearch for code in a workspace
SnippetsApiSnippetsGetGet /snippetsList snippets
SnippetsApiSnippetsPostPost /snippetsCreate a snippet
SnippetsApiSnippetsWorkspaceEncodedIdCommentsCommentIdDeleteDelete /snippets/{workspace}/{encoded_id}/comments/{comment_id}Delete a comment on a snippet
SnippetsApiSnippetsWorkspaceEncodedIdCommentsCommentIdGetGet /snippets/{workspace}/{encoded_id}/comments/{comment_id}Get a comment on a snippet
SnippetsApiSnippetsWorkspaceEncodedIdCommentsCommentIdPutPut /snippets/{workspace}/{encoded_id}/comments/{comment_id}Update a comment on a snippet
SnippetsApiSnippetsWorkspaceEncodedIdCommentsGetGet /snippets/{workspace}/{encoded_id}/commentsList comments on a snippet
SnippetsApiSnippetsWorkspaceEncodedIdCommentsPostPost /snippets/{workspace}/{encoded_id}/commentsCreate a comment on a snippet
SnippetsApiSnippetsWorkspaceEncodedIdCommitsGetGet /snippets/{workspace}/{encoded_id}/commitsList snippet changes
SnippetsApiSnippetsWorkspaceEncodedIdCommitsRevisionGetGet /snippets/{workspace}/{encoded_id}/commits/{revision}Get a previous snippet change
SnippetsApiSnippetsWorkspaceEncodedIdDeleteDelete /snippets/{workspace}/{encoded_id}Delete a snippet
SnippetsApiSnippetsWorkspaceEncodedIdFilesPathGetGet /snippets/{workspace}/{encoded_id}/files/{path}Get a snippet's raw file at HEAD
SnippetsApiSnippetsWorkspaceEncodedIdGetGet /snippets/{workspace}/{encoded_id}Get a snippet
SnippetsApiSnippetsWorkspaceEncodedIdNodeIdDeleteDelete /snippets/{workspace}/{encoded_id}/{node_id}Delete a previous revision of a snippet
SnippetsApiSnippetsWorkspaceEncodedIdNodeIdFilesPathGetGet /snippets/{workspace}/{encoded_id}/{node_id}/files/{path}Get a snippet's raw file
SnippetsApiSnippetsWorkspaceEncodedIdNodeIdGetGet /snippets/{workspace}/{encoded_id}/{node_id}Get a previous revision of a snippet
SnippetsApiSnippetsWorkspaceEncodedIdNodeIdPutPut /snippets/{workspace}/{encoded_id}/{node_id}Update a previous revision of a snippet
SnippetsApiSnippetsWorkspaceEncodedIdPutPut /snippets/{workspace}/{encoded_id}Update a snippet
SnippetsApiSnippetsWorkspaceEncodedIdRevisionDiffGetGet /snippets/{workspace}/{encoded_id}/{revision}/diffGet snippet changes between versions
SnippetsApiSnippetsWorkspaceEncodedIdRevisionPatchGetGet /snippets/{workspace}/{encoded_id}/{revision}/patchGet snippet patch between versions
SnippetsApiSnippetsWorkspaceEncodedIdWatchDeleteDelete /snippets/{workspace}/{encoded_id}/watchStop watching a snippet
SnippetsApiSnippetsWorkspaceEncodedIdWatchGetGet /snippets/{workspace}/{encoded_id}/watchCheck if the current user is watching a snippet
SnippetsApiSnippetsWorkspaceEncodedIdWatchPutPut /snippets/{workspace}/{encoded_id}/watchWatch a snippet
SnippetsApiSnippetsWorkspaceEncodedIdWatchersGetGet /snippets/{workspace}/{encoded_id}/watchersList users watching a snippet
SnippetsApiSnippetsWorkspaceGetGet /snippets/{workspace}List snippets in a workspace
SnippetsApiSnippetsWorkspacePostPost /snippets/{workspace}Create a snippet for a workspace
SourceApiRepositoriesWorkspaceRepoSlugFilehistoryCommitPathGetGet /repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path}List commits that modified a file
SourceApiRepositoriesWorkspaceRepoSlugSrcCommitPathGetGet /repositories/{workspace}/{repo_slug}/src/{commit}/{path}Get file or directory contents
SourceApiRepositoriesWorkspaceRepoSlugSrcGetGet /repositories/{workspace}/{repo_slug}/srcGet the root directory of the main branch
SourceApiRepositoriesWorkspaceRepoSlugSrcPostPost /repositories/{workspace}/{repo_slug}/srcCreate a commit by uploading a file
SshApiUsersSelectedUserSshKeysGetGet /users/{selected_user}/ssh-keysList SSH keys
SshApiUsersSelectedUserSshKeysKeyIdDeleteDelete /users/{selected_user}/ssh-keys/{key_id}Delete a SSH key
SshApiUsersSelectedUserSshKeysKeyIdGetGet /users/{selected_user}/ssh-keys/{key_id}Get a SSH key
SshApiUsersSelectedUserSshKeysKeyIdPutPut /users/{selected_user}/ssh-keys/{key_id}Update a SSH key
SshApiUsersSelectedUserSshKeysPostPost /users/{selected_user}/ssh-keysAdd a new SSH key
TeamsApiTeamsGetGet /teamsList teams a user is part of
TeamsApiTeamsUsernameFollowersGetGet /teams/{username}/followersList team followers
TeamsApiTeamsUsernameFollowingGetGet /teams/{username}/followingList accounts a team is following
TeamsApiTeamsUsernameGetGet /teams/{username}Get a team
TeamsApiTeamsUsernameMembersGetGet /teams/{username}/membersList team members
TeamsApiTeamsUsernamePermissionsGetGet /teams/{username}/permissionsList team permissions for a user
TeamsApiTeamsUsernamePermissionsRepositoriesGetGet /teams/{username}/permissions/repositoriesList repository permissions for a team
TeamsApiTeamsUsernamePermissionsRepositoriesRepoSlugGetGet /teams/{username}/permissions/repositories/{repo_slug}List repository permissions for a team
TeamsApiTeamsWorkspaceRepositoriesGetGet /teams/{workspace}/repositoriesList workspace repositories
TeamsApiUserPermissionsTeamsGetGet /user/permissions/teamsList team permissions for the user
TeamsApiUsersWorkspaceRepositoriesGetGet /users/{workspace}/repositoriesList workspace repositories
UsersApiTeamsWorkspaceRepositoriesGetGet /teams/{workspace}/repositoriesList workspace repositories
UsersApiUserEmailsEmailGetGet /user/emails/{email}Get an email address for current user
UsersApiUserEmailsGetGet /user/emailsList email addresses for current user
UsersApiUserGetGet /userGet current user
UsersApiUsersSelectedUserGetGet /users/{selected_user}Get a user
UsersApiUsersUsernameMembersGetGet /users/{username}/membersList team users
UsersApiUsersWorkspaceRepositoriesGetGet /users/{workspace}/repositoriesList workspace repositories
WebhooksApiHookEventsGetGet /hook_eventsGet a webhook resource
WebhooksApiHookEventsSubjectTypeGetGet /hook_events/{subject_type}List subscribable webhook types
WebhooksApiRepositoriesWorkspaceRepoSlugHooksGetGet /repositories/{workspace}/{repo_slug}/hooksList webhooks for a repository
WebhooksApiRepositoriesWorkspaceRepoSlugHooksPostPost /repositories/{workspace}/{repo_slug}/hooksCreate a webhook for a repository
WebhooksApiRepositoriesWorkspaceRepoSlugHooksUidDeleteDelete /repositories/{workspace}/{repo_slug}/hooks/{uid}Delete a webhook for a repository
WebhooksApiRepositoriesWorkspaceRepoSlugHooksUidGetGet /repositories/{workspace}/{repo_slug}/hooks/{uid}Get a webhook for a repository
WebhooksApiRepositoriesWorkspaceRepoSlugHooksUidPutPut /repositories/{workspace}/{repo_slug}/hooks/{uid}Update a webhook for a repository
WebhooksApiWorkspacesWorkspaceHooksGetGet /workspaces/{workspace}/hooksList webhooks for a workspace
WebhooksApiWorkspacesWorkspaceHooksPostPost /workspaces/{workspace}/hooksCreate a webhook for a workspace
WebhooksApiWorkspacesWorkspaceHooksUidDeleteDelete /workspaces/{workspace}/hooks/{uid}Delete a webhook for a workspace
WebhooksApiWorkspacesWorkspaceHooksUidGetGet /workspaces/{workspace}/hooks/{uid}Get a webhook for a workspace
WebhooksApiWorkspacesWorkspaceHooksUidPutPut /workspaces/{workspace}/hooks/{uid}Update a webhook for a workspace
WorkspacesApiUserPermissionsWorkspacesGetGet /user/permissions/workspacesList workspaces for the current user
WorkspacesApiWorkspacesGetGet /workspacesList workspaces for user
WorkspacesApiWorkspacesWorkspaceGetGet /workspaces/{workspace}Get a workspace
WorkspacesApiWorkspacesWorkspaceHooksGetGet /workspaces/{workspace}/hooksList webhooks for a workspace
WorkspacesApiWorkspacesWorkspaceHooksPostPost /workspaces/{workspace}/hooksCreate a webhook for a workspace
WorkspacesApiWorkspacesWorkspaceHooksUidDeleteDelete /workspaces/{workspace}/hooks/{uid}Delete a webhook for a workspace
WorkspacesApiWorkspacesWorkspaceHooksUidGetGet /workspaces/{workspace}/hooks/{uid}Get a webhook for a workspace
WorkspacesApiWorkspacesWorkspaceHooksUidPutPut /workspaces/{workspace}/hooks/{uid}Update a webhook for a workspace
WorkspacesApiWorkspacesWorkspaceMembersGetGet /workspaces/{workspace}/membersList users in a workspace
WorkspacesApiWorkspacesWorkspaceMembersMemberGetGet /workspaces/{workspace}/members/{member}Get user membership for a workspace
WorkspacesApiWorkspacesWorkspacePermissionsGetGet /workspaces/{workspace}/permissionsList user permissions in a workspace
WorkspacesApiWorkspacesWorkspacePermissionsRepositoriesGetGet /workspaces/{workspace}/permissions/repositoriesList all repository permissions for a workspace
WorkspacesApiWorkspacesWorkspacePermissionsRepositoriesRepoSlugGetGet /workspaces/{workspace}/permissions/repositories/{repo_slug}List a repository permissions for a workspace
WorkspacesApiWorkspacesWorkspaceProjectsGetGet /workspaces/{workspace}/projectsList projects in a workspace
WorkspacesApiWorkspacesWorkspaceProjectsProjectKeyGetGet /workspaces/{workspace}/projects/{project_key}Get a project for a workspace

Documentation For Models

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
  • runner: Access your workspaces/repositories' runners
  • runner:write: Access and edit your workspaces/repositories' runners
  • 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]